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

On Aug 21, 2006, at 2:34 PM, Eric Hodel wrote:

> On Aug 21, 2006, at 8:00 AM, Mat Schaffer wrote:
>> On Aug 21, 2006, at 10:22 AM, mathew wrote:
>>> * Make the first page (the one named after the package/library)  
>>> contain an introduction to what the package does, why you should  
>>> use it, and links to any relevant standards (e.g. RFCs).
>> 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?
>
> The module/class comment goes in front of Init_blah.

That's what I did, but the 'pty' link in the left navigation bar  
still points to shl.rb, and clicking pty.c yields an empty doc page.   
I can see the documentation associated with Init_pty only by clicking  
on the PTY class.

I'll try it on HEAD and maybe it'll be different.  I just can't  
figure out what etc.c is doing that points the left-side 'etc' link  
straight at the Etc module.  Seems like it's happening elsewhere.
-Mat