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
Kurt M. Dresner wrote:
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?
RDoc is nice, but I can’t compare with doxygen, since I haven’t used it:
(That’s hit #4 when I google the subject of your email 
)
You can see a good example at:
Hi there Kurt,
Perhaps rDoc is what you are after?
http://rdoc.sourceforge.net/
Have fun with it 
Signed,
Holden Glova
···
On Sun, 20 Jul 2003 15:17, Kurt M. Dresner wrote:
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
···
On Sunday, July 20, 2003, 1:17:24 PM, Kurt wrote:
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
and in xml and in MS chm… I wonder if someone would like to write
generators for tex/ps/pdf
Hi –
···
On Sun, 20 Jul 2003, gabriele renzi wrote:
il Sun, 20 Jul 2003 12:29:28 +0900, Gavin Sinclair > gsinclair@soyabean.com.au ha scritto::
RDoc is Ruby’s Javadoc: comments from the source code are extracted
into HTML. See rdoc.sourceforge.organd in xml and in MS chm… I wonder if someone would like to write
generators for tex/ps/pdf
In the contrib directory of RDoc you’ll find some PDF stuff – still in
progress, though admittedly I haven’t done anything with it for a while.
It produces nice results for some things, but doesn’t deal comprehensively
with different RDoc scenarios.
David
–
David Alan Black
home: dblack@superlink.net
work: blackdav@shu.edu
Web: http://pirate.shu.edu/~blackdav
When I’m done with PDF::Writer, I will be trying to add a PDF generator to
RDoc. (PDF::Writer is a native Ruby – that is, no C extensions required –
PDF document generator. It works, for the most part, but I’m stuck with a
transactional problem at the moment. It may be faster with Ruby 1.8, but I
haven’t yet had time to test 1.8 – computer problems dominate.)
-austin
···
On Sun, 20 Jul 2003 23:14:54 +0900, gabriele renzi wrote:
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
–
austin ziegler * austin@halostatue.ca * Toronto, ON, Canada
software designer * pragmatic programmer * 2003.07.20
* 11:34:36
gabriele renzi wrote:
RDoc is Ruby’s Javadoc: comments from the source code are extracted
into HTML. See rdoc.sourceforge.organd 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
···
il Sun, 20 Jul 2003 12:29:28 +0900, Gavin Sinclair > gsinclair@soyabean.com.au ha scritto::
too cool!
how fast could it be? I mean, could it be used for real time pdf
generation (apart from rdoc and the like)?
···
il Mon, 21 Jul 2003 00:36:14 +0900, Austin Ziegler austin@halostatue.ca ha scritto::
When I’m done with PDF::Writer, I will be trying to add a PDF generator to
RDoc. (PDF::Writer is a native Ruby – that is, no C extensions required –
I’m not quite sure how fast at this point. I am pretty sure it will
require 1.8, but I haven’t had a chance to test the latest version
here (I had to restore my system last week and I think that I’m just
now back up to speed). It requires some level of object
transactional support, and the Transaction::Simple that I released a
couple of weeks ago is painfully slow on Win32. Without the
transactional stuff, it doesn’t work properly – but it was
relatively fast on what it does do (~20 seconds to make a 60k
document). The transactional stuff under 1.6 slowed it down to > 1
hour. I will be trying 1.8 tomorrow, I think.
-austin
···
On Mon, 21 Jul 2003 00:55:16 +0900, gabriele renzi wrote:
austin@halostatue.ca ha scritto::
When I’m done with PDF::Writer, I will be trying to add a PDF
generator to RDoc. (PDF::Writer is a native Ruby – that is, no C
extensions required –
too cool! how fast could it be? I mean, could it be used for real
time pdf generation (apart from rdoc and the like)?
–
austin ziegler * austin@halostatue.ca * Toronto, ON, Canada
software designer * pragmatic programmer * 2003.07.27
* 21.53.21
Okay. I just tried it with an old version of 1.8 (1.8.0-9) on Win32 and
the speed isn’t ~20 seconds, but it’s less than ~60 seconds at this point.
The output is slightly buggered, but I think I can fix that in other ways.
I’ll have to trace around the output to figure out exactly why it’s not
right. Then I can move forward to the rest of it.
After I do that, I’m going to clean up the API to be more Ruby-like (it’s
still very PHPish) and then I will post something alpha-level. The code will
work and be usable, but I have plans for the internals that may also affect
the externals (PDF documents use a lot of references; I can make it so that
the references are finalized only at document creation time instead of at
add time, which will make everything easier).
-austin
···
On Mon, 28 Jul 2003 10:58:38 +0900, Austin Ziegler wrote:
On Mon, 21 Jul 2003 00:55:16 +0900, gabriele renzi wrote:
austin@halostatue.ca ha scritto::
When I’m done with PDF::Writer, I will be trying to add a PDF
generator to RDoc. (PDF::Writer is a native Ruby – that is, no C
extensions required –
too cool! how fast could it be? I mean, could it be used for real time
pdf generation (apart from rdoc and the like)?
I’m not quite sure how fast at this point. I am pretty sure it will
require 1.8, but I haven’t had a chance to test the latest version here
(I had to restore my system last week and I think that I’m just now back
up to speed). It requires some level of object transactional support, and
the Transaction::Simple that I released a couple of weeks ago is
painfully slow on Win32. Without the transactional stuff, it doesn’t work
properly – but it was relatively fast on what it does do (~20 seconds to
make a 60k document). The transactional stuff under 1.6 slowed it down to
1 hour. I will be trying 1.8 tomorrow, I think.
–
austin ziegler * austin@halostatue.ca * Toronto, ON, Canada
software designer * pragmatic programmer * 2003.07.28
* 02.36.48
Austin Ziegler wrote:
···
On Mon, 28 Jul 2003 10:58:38 +0900, Austin Ziegler wrote:
On Mon, 21 Jul 2003 00:55:16 +0900, gabriele renzi wrote:
austin@halostatue.ca ha scritto::
When I’m done with PDF::Writer, I will be trying to add a PDF
generator to RDoc. (PDF::Writer is a native Ruby – that is, no C
extensions required –
FWIW, I’ve got a simple-minded Postscript class up on my homepage.
http://users.rcn.com/m3ha11/ruby/Plots-0.3.tar.gz
Too much of the formatting is still left up to the user,
but I’m looking into adding text justification, etc.