"Holden Glova" <dsafari / xtra.co.nz> wrote in message
news:20020330004045.OYFY20246.mta3-rme.xtra.co.nz / there...
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> On Sat, 30 Mar 2002 12:13, Sean O'Dell wrote:
> > "Holden Glova" <dsafari / xtra.co.nz> wrote in message
> > news:20020322080520.IMRK8792.mta1-rme.xtra.co.nz / there...
> >
> > > -----BEGIN PGP SIGNED MESSAGE-----
> > > Hash: SHA1
> > >
> > > On Fri, 22 Mar 2002 16:09, Gary Lawrence Murphy wrote:
> > > > Ok, confess: /how/ did you generate the web-based class browser for
> > > > REXML and /how/ can I get more of ruby documented in this way?
> > >
> > > Perhaps you are referring to RDoc?
> > >
> > > http://rdoc.sourceforge.net
> >
> > I was just going to ask about documentation for REXML.  I couldn't find
> > much at the REXML web site; not sure if what's there is incomplete or
maybe
> > the documentation system there is broken right now.
> >
> > Could someone give me a real quick brief on what RDoc is and where it is
so
> > I can give it a try?  It doesn't seem to be a unix command...not sure
where
> > to get started with it.
> >
> >     Sean
>
> Hi Sean,
>
> RDoc is a javadoc like tool for Ruby except much smarter! Go to
> http://rdoc.sourceforge.net download, install and oooOOOoo at the fancy
> documentation you have (assuming you wrote any comments that is).

Wait, I see what it did...it generated a doc directory with a bunch of HTML
files in there.  Hmm.  I just installed REXML and I don't see any
documentation for REXML anywhere in there.  Still...lacking some vital clues
here it seems.

Also, I'm looking at some of the methods being documented, and there isn't
much information there; just method names.  Also, seems like most methods
have, where parameters should be, just %params%.  How do I know what
parameters I need to pass?

I'm really not a stupid person...this is all just very, very odd to me.  I
just want some documentation on REXML, the classes, the class methods, the
parameters they want, what each method does, perhaps even with a little bit
of example code for each method.  How do I from here (not having
documentation) to there (having documentation)?

    Sean