Hi Devs, Been exploring some RDoc templates and rdoc tasks. Attached are the current rdoc presentation of the SmtpClient class and one alternative candidate. Requires adding three of files to ./ext/ (or requiring the allison gem) and the markaby gem. Just for kicks Mark -------------- next part -------------- A non-text attachment was scrubbed... Name: EM-doc-current.png Type: image/png Size: 125125 bytes Desc: not available Url : http://rubyforge.org/pipermail/eventmachine-talk/attachments/20080106/8cee5d0b/attachment-0002.png -------------- next part -------------- A non-text attachment was scrubbed... Name: EM-dev-doc-proto.png Type: image/png Size: 147345 bytes Desc: not available Url : http://rubyforge.org/pipermail/eventmachine-talk/attachments/20080106/8cee5d0b/attachment-0003.png
Can''t say I''ve ever really been a fan of the default rDoc output, though I''ve yet to see a documentation output of any language that I really like. Doxygen comes close, but then it''s hard to search for specific methods / classes. I''m definitely up for trying this other format, it looks clean and easily searchable for whatever you''re looking for. Jason On Jan 5, 2008 9:54 PM, Mark Van De Vyver <mvyver at gmail.com> wrote:> Hi Devs, > > Been exploring some RDoc templates and rdoc tasks. Attached are the > current rdoc presentation of the SmtpClient class and one alternative > candidate. > Requires adding three of files to ./ext/ (or requiring the allison > gem) and the markaby gem. > > Just for kicks > Mark > > _______________________________________________ > Eventmachine-talk mailing list > Eventmachine-talk at rubyforge.org > http://rubyforge.org/mailman/listinfo/eventmachine-talk >-------------- next part -------------- An HTML attachment was scrubbed... URL: http://rubyforge.org/pipermail/eventmachine-talk/attachments/20080106/1819c9d8/attachment.html
On Jan 6, 2008 4:09 PM, Jason Roelofs <jameskilton at gmail.com> wrote:> Can''t say I''ve ever really been a fan of the default rDoc output, though > I''ve yet to see a documentation output of any language that I really like. > Doxygen comes close, but then it''s hard to search for specific methods / > classes.Doxygen is nice, NaturalDocs seems its equal if not better. ND only has partial Ruby support though I noticed that Ruby''s HornetsEye seems to use ND. Mark> I''m definitely up for trying this other format, it looks clean and easily > searchable for whatever you''re looking for. > > Jason > > > > On Jan 5, 2008 9:54 PM, Mark Van De Vyver < mvyver at gmail.com> wrote: > > > > > > > > Hi Devs, > > > > Been exploring some RDoc templates and rdoc tasks. Attached are the > > current rdoc presentation of the SmtpClient class and one alternative > > candidate. > > Requires adding three of files to ./ext/ (or requiring the allison > > gem) and the markaby gem. > > > > Just for kicks > > Mark > > > > _______________________________________________ > > Eventmachine-talk mailing list > > Eventmachine-talk at rubyforge.org > > http://rubyforge.org/mailman/listinfo/eventmachine-talk > > > > > _______________________________________________ > Eventmachine-talk mailing list > Eventmachine-talk at rubyforge.org > http://rubyforge.org/mailman/listinfo/eventmachine-talk >
Anything besides the default is probably nicer :)
plug it into puredocs and you can use whatever you like... might need a little work though On 6 Jan 2008, at 05:23, Mark Van De Vyver wrote:> On Jan 6, 2008 4:09 PM, Jason Roelofs <jameskilton at gmail.com> wrote: >> Can''t say I''ve ever really been a fan of the default rDoc output, >> though >> I''ve yet to see a documentation output of any language that I >> really like. >> Doxygen comes close, but then it''s hard to search for specific >> methods / >> classes. > > Doxygen is nice, NaturalDocs seems its equal if not better. ND only > has partial Ruby support though I noticed that Ruby''s HornetsEye seems > to use ND. > > Mark > >> I''m definitely up for trying this other format, it looks clean and >> easily >> searchable for whatever you''re looking for. >> >> Jason >> >> >> >> On Jan 5, 2008 9:54 PM, Mark Van De Vyver < mvyver at gmail.com> wrote: >>> >>> >>> >>> Hi Devs, >>> >>> Been exploring some RDoc templates and rdoc tasks. Attached are the >>> current rdoc presentation of the SmtpClient class and one >>> alternative >>> candidate. >>> Requires adding three of files to ./ext/ (or requiring the allison >>> gem) and the markaby gem. >>> >>> Just for kicks >>> Mark >>> >>> _______________________________________________ >>> Eventmachine-talk mailing list >>> Eventmachine-talk at rubyforge.org >>> http://rubyforge.org/mailman/listinfo/eventmachine-talk >>> >> >> >> _______________________________________________ >> Eventmachine-talk mailing list >> Eventmachine-talk at rubyforge.org >> http://rubyforge.org/mailman/listinfo/eventmachine-talk >> > _______________________________________________ > Eventmachine-talk m