[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

RDoc- Merging docs, ri

Nicholas Van Weerdenburg

12/16/2004 4:28:00 AM

Hi,

I have a couple of RDoc questions:

1. is there a way to generate rdoc so you can do "rdoc <filename>. I
often remember the require filename (e.g. require "log4r") but forget
the class names.

2. can rdoc merge multiple sources of documentation? e.g. if I open a
class and add new members in a second ruby file, I might want the
comments added to the main files rdoc (ideally with an appropriate
header "customerString.rb Additions:" or like).

Thanks,
Nick
--
Nicholas Van Weerdenburg
2 Answers

Dave Thomas

12/16/2004 9:31:00 PM

0


On Dec 15, 2004, at 22:28, Nicholas Van Weerdenburg wrote:

> 1. is there a way to generate rdoc so you can do "rdoc <filename>. I
> often remember the require filename (e.g. require "log4r") but forget
> the class names.

If you use the web interface (lloking at the HTML) it shows you the
file names, and you can click on them. ri doesn't support this.

>
> 2. can rdoc merge multiple sources of documentation? e.g. if I open a
> class and add new members in a second ruby file, I might want the
> comments added to the main files rdoc (ideally with an appropriate
> header "customerString.rb Additions:" or like).

When generating ri output, rdoc merges descriptions. Whren generating
html, it work, but only if you supply all the sources of the
information at the same time (ie go rdoc file1.rb file2.rb)


Cheers

Dave

Nicholas Van Weerdenburg

12/17/2004 1:02:00 AM

0

On Fri, 17 Dec 2004 06:30:37 +0900, Dave Thomas <pragdave@gmail.com> wrote:
>
> On Dec 15, 2004, at 22:28, Nicholas Van Weerdenburg wrote:
>
> > 1. is there a way to generate rdoc so you can do "rdoc <filename>. I
> > often remember the require filename (e.g. require "log4r") but forget
> > the class names.
>

Ooops. Meant "ri <filename>".

> If you use the web interface (lloking at the HTML) it shows you the
> file names, and you can click on them. ri doesn't support this.
>
> >
> > 2. can rdoc merge multiple sources of documentation? e.g. if I open a
> > class and add new members in a second ruby file, I might want the
> > comments added to the main files rdoc (ideally with an appropriate
> > header "customerString.rb Additions:" or like).
>
> When generating ri output, rdoc merges descriptions. Whren generating
> html, it work, but only if you supply all the sources of the
> information at the same time (ie go rdoc file1.rb file2.rb)
>
> Cheers
>
> Dave
>
>

Thanks. I'll try that.

--
Nicholas Van Weerdenburg