ruby documentation generator?

[Kurt M. Dresner]

I've been googling for a few minutes but I haven't found anything yet.

Is there a tool similar to Doxygen for ruby? I want to document my code
so others can understand it better. Can anyone point me anywhere?

-Kurt

 

[Holden Glova]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I've been googling for a few minutes but I haven't found anything yet.

Is there a tool similar to Doxygen for ruby? I want to document my code
so others can understand it better. Can anyone point me anywhere?

-Kurt

Hi there Kurt,

Perhaps rDoc is what you are after?
http://rdoc.sourceforge.net/

Have fun with it

- --
Signed,
Holden Glova
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (GNU/Linux)

iD8DBQE/GgyB0X8w8X71zPcRAuZfAJ9QWZ4zUuoJPlKoUOdEIwTWj64NQgCfUsJW
sHVvklxYkdsEfWgBwsNoXMY=
=Il0b
-----END PGP SIGNATURE-----

 

[Gavin Sinclair]

I've been googling for a few minutes but I haven't found anything yet.

Is there a tool similar to Doxygen for ruby? I want to document my code
so others can understand it better. Can anyone point me anywhere?

-Kurt

RDoc is Ruby's Javadoc: comments from the source code are extracted
into HTML. See rdoc.sourceforge.org

Gavin

 

[gabriele renzi]

il Sun, 20 Jul 2003 12:29:28 +0900, Gavin Sinclair

RDoc is Ruby's Javadoc: comments from the source code are extracted
into HTML. See rdoc.sourceforge.org

and in xml and in MS chm.. I wonder if someone would like to write
generators for tex/ps/pdf

 

[Dave Thomas]

il Sun, 20 Jul 2003 12:29:28 +0900, Gavin Sinclair
<[email protected]> ha scritto::





and in xml and in MS chm.. I wonder if someone would like to write
generators for tex/ps/pdf

If you look in the markup/ directory of a CVS copy of RDoc you'll find
rdoc2latex: this takes a plain file written using RDoc markup and
generates LaTeX. It uses SM::ToLatex, which generates LaTeX from inline
RDoc. It wouldn't be hard to adapt this to make it work with rdoc proper
(that is, make it work through the templating system). Right now I don't
have the time myself...

Cheers


Dave