# Rdoc does not document UTF-8 files?

**URL:** <https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975>\
**Category:** Ruby\
**Created:** [June 10, 2009, 9:00pm UTC](https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975 "2009-06-10T21:00:51Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![quintus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/q/49beb7/32.png) [@quintus](https://www.ruby-forum.com/u/quintus)\
**Post date:** [June 10, 2009, 9:00pm UTC](https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975/1 "2009-06-10T21:00:51Z")

</div>

Hi,

yesterday I tried to document a piece of code I had written in Ruby 1.9.  
But it turned out that Rdoc wasn’t able to document my UTF-8 encoded  
file! Reduced to a minimal example, this file…

#Encoding: UTF-8  
#test file

#test class  
class A

#test method  
def a  
puts “a”  
end

end

…can’t be documented if encoded in UTF-8. When I tried it again with  
an encoding of Windows-1252 (yes, I’m using Ruby on Windows…) it  
worked fine. I tried both the versions 2.2.2 and 2.4.3 of Rdoc but  
neither of it worked - regardless of whether I used an additional “-c  
UTF-8” parameter or not.

I’m using ruby 1.9.1-p129 on Windows XP SP3. Because I was telled at the  
German Ruby forum  
([http://forum.ruby-portal.de/viewtopic.php?f=22&t=9792](http://forum.ruby-portal.de/viewtopic.php?f=22&t=9792)) that this worked  
fine on OS X I suspect that this is a Windows issue. Is there some fix  
about it or am I just doing something wrong?

Marvin

---

<div class="post-metadata">

**Author:** ![quintus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/q/49beb7/32.png) [@quintus](https://www.ruby-forum.com/u/quintus)\
**Post date:** [June 10, 2009, 10:32pm UTC](https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975/2 "2009-06-10T22:32:48Z")

</div>

On Jun 10, 2009, at 12:00, Marvin Gülker wrote:

> neither of it worked - regardless of whether I used an additional “-c  
> UTF-8” parameter or not.

The -c parameter currently only controls the value that shows up in  
the HTML meta element. Eventually it will control the encoding of the  
output files, but never the input files.

> I’m using ruby 1.9.1-p129 on Windows XP SP3. Because I was telled at  
> the  
> German Ruby forum  
> ([http://forum.ruby-portal.de/viewtopic.php?f=22&t=9792](http://forum.ruby-portal.de/viewtopic.php?f=22&t=9792)) that this  
> worked  
> fine on OS X I suspect that this is a Windows issue. Is there some fix  
> about it or am I just doing something wrong?

It doesn’t work for me on OS X, please file a bug.

---

<div class="post-metadata">

**Author:** ![quintus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/q/49beb7/32.png) [@quintus](https://www.ruby-forum.com/u/quintus)\
**Post date:** [June 11, 2009, 12:50am UTC](https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975/3 "2009-06-11T00:50:17Z")

</div>

Eric H. wrote:

> It doesn’t work for me on OS X, please file a bug.

Sorry, but I’ve never filed a Rdoc or even Ruby bug before. Where can I  
do this?

Marvin

---

<div class="post-metadata">

**Author:** ![quintus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/q/49beb7/32.png) [@quintus](https://www.ruby-forum.com/u/quintus)\
**Post date:** [June 11, 2009, 1:04am UTC](https://www.ruby-forum.com/t/rdoc-does-not-document-utf-8-files/169975/4 "2009-06-11T01:04:03Z")

</div>

On Jun 10, 2009, at 15:50, Marvin Gülker wrote:

> Eric H. wrote:
> 
> > It doesn’t work for me on OS X, please file a bug.
> 
> Sorry, but I’ve never filed a Rdoc or even Ruby bug before. Where  
> can I  
> do this?

[http://rubyforge.org/tracker/?atid=2472&group\_id=627&func=browse](http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse)