Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > Rdoc does not document UTF-8 files?

Reply
Thread Tools

Rdoc does not document UTF-8 files?

 
 
Marvin Gülker
Guest
Posts: n/a
 
      06-10-2009
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) 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
--
Posted via http://www.ruby-forum.com/.

 
Reply With Quote
 
 
 
 
Eric Hodel
Guest
Posts: n/a
 
      06-10-2009
On Jun 10, 2009, at 12:00, Marvin G=FClker wrote:
> yesterday I tried to document a piece of code I had written in Ruby =20=


> 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.


The -c parameter currently only controls the value that shows up in =20
the HTML meta element. Eventually it will control the encoding of the =20=

output files, but never the input files.

> I'm using ruby 1.9.1-p129 on Windows XP SP3. Because I was telled at =20=


> the
> German Ruby forum
> (http://forum.ruby-portal.de/viewtopi...=3D22&t=3D9792) that this =20=


> 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.



 
Reply With Quote
 
 
 
 
Marvin Gülker
Guest
Posts: n/a
 
      06-10-2009
Eric Hodel 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
--
Posted via http://www.ruby-forum.com/.

 
Reply With Quote
 
Eric Hodel
Guest
Posts: n/a
 
      06-10-2009
On Jun 10, 2009, at 15:50, Marvin G=FClker wrote:
> Eric Hodel 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 =20
> can I
> do this?


http://rubyforge.org/tracker/?atid=3...func=3Dbrowse=

 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
darkfish-rdoc (1.1.5) not working with rdoc (2.4.3) Iñaki Baz Castillo Ruby 2 04-06-2009 07:57 AM
rdoc: how to add readme.rdoc as index.html? Iwan van der Kleyn Ruby 1 04-26-2005 12:37 PM
[RDOC] Using a template causes rdoc not to document some classes Daniel Berger Ruby 1 11-02-2004 08:23 PM
rdoc bug (and rdoc bug tracker site is down) Brian Schröder Ruby 5 09-18-2004 02:08 PM
rdoc: how to generate rdoc & ri documentation of standard library? Andreas Schwarz Ruby 6 01-01-2004 03:09 AM



Advertisments
 



1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57