From: Mikkel Bruun <mikkel@...>
Date: 2001-12-16T21:30:01+09:00
Subject: [ruby-talk:28672] Re: RDoc - Document Ruby source files

wow...

This is pretty kewl...

I have tried runnig it on all my homegrown scripts and so far I havent seen
any bugs...
But now i feel so bad for not writing any comments in my code...


Mikkel


----- Original Message -----
From: "Dave Thomas" <Dave@PragmaticProgrammer.com>
To: "ruby-talk ML" <ruby-talk@ruby-lang.org>
Sent: Sunday, December 16, 2001 3:28 AM
Subject: [ruby-talk:28655] RDoc - Document Ruby source files


>
> There's an alpha version of my Ruby documentation package available at
>
> http://www.pragmaticprogrammer.com/ruby/downloads/files/rdoc-alpha.tgz
>
> It parses a group of Ruby files, extracting class, module, method, and
> attribute definitions, along with any associated comments. It formats
> the comments using (I hope) fairly intuitive rules, and writes the
> result as a documentation tree (Currently in HTML, but that part is
> pluggable).
>
> RDoc includes the SimpleMarkup package, which it uses to format the
> comment blocks. SimpleMarkup is more generally applicable: I intend to
> use it in all my subsequent text-based things (FAQs, Wikis and so on),
> so now would be a good time to comment on it.
>
> I'm sure this code has many holes, so I'd appreciate feedback, bug
> reports, fixes, and so on. I'm also hoping people will be writing
> different backends for it (like the UML diagram generator that was
> discussed a while back). If you want to do that, drop me an e-mail and
> we can discuss the interface.
>
>
> Cheers
>
>
> Dave
>