Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button

Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c): msg#00048

Subject: Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)

On Aug 21, 2006, at 10:35 PM, mathew wrote:

Mat Schaffer wrote:
Actually, I was wondering about this. When I patched pty.c, clicking on the pty link still yielded shl.rb. How can I fix it to reference the PTY class? Also, where can you place summary information for a C file. Can you just put it at the top?

Take a look at bigdecimal if you need an example. Lots of that was C code. I experimented quite a bit to find out where to comment things, to get the comments to show up in the right place in the Rdoc.

Cool, this will definitely help. Though I notice it still has the same linking problem. The default page when you click on 'bigdecimal' in the index is 'newton.rb'. Anyone know how stdlib-doc determines what the "main" page of the package? Or maybe you do and what I'm looking at (ruby-doc.org docs) is just too old.

Either way, thanks for the pointers, I'll do my best to pass your advice onto other newcomers. Enjoy your vacation!
-Mat




<Prev in Thread] Current Thread [Next in Thread>