Re: How to fix docs for Zlib::GzipReader#wrap ?
Roger Pack <[email protected]> Wed, 20 Jan 2010 11:42:44 -0700
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
> I've submitted doc patches before, so that part of the process, including > discussing it as per this URL, is OK. =A0My difficulty is that I'm failin= g > to see how to get Rdoc to pick up the docs associated with rb_gzfile_s_wr= ap > and associate them correctly with GzipReader and GzipWriter. =A0Maybe I > don't need to do much that's special for that to work, and just make sure > I don't refer to a specific class in the docs there? if there's a .document file you'll have to specify the .rdoc file there [and all others] if there's not, you'll either have to create one or move the docs to be inl= ine. -r > It would be moving the comments inline, but it's doing it in > such a way that it gets picked up correctly. =A0For Ruby source > this is much more straightforward, than for C source. looks like there's some examples here: http://rdoc.rubyforge.org/RDoc/Parser/C.html -r