From: Dave Thomas <dave@...>
Date: 2004-11-13T04:54:05+09:00
Subject: Re: RDOC Question -- including parent class accessors, and linking other classes


On Nov 12, 2004, at 12:42, John Wilger wrote:

>> What would I have to do to have both "ChildClass#child_reader" _and_
>> "ChildClass#parent_reader" documented in the RDOC class file for
>> ChildClass? Currently, I only see "ChildClass#child_reader" in the
>> docs for ChildClass, and you have to view the parent class to see the
>> documentation for "ParentClass#parent_reader".

RDoc doesn't currently let you do this: the problem really is knowing 
where to stop--do you document all of the parent's methods, and its 
parent's methods, and so on.

I'm open to ideas here.

>> Also, my generated RDOC documentation does not seem to automatically
>> be creating links out of class names in the documentation. I am
>> developing an application with Rails, and I have some code placed in
>> the 'lib' subdirectory. In some of the documentation comments, I refer
>> to the name of a model class which is stored in the 'app/models'
>> subdirectory. However, the HTML documentation does not create a link
>> from the class in 'lib' to the model class when I run rdoc from the
>> command line above both directories. Any thoughts?

Could you email me a minimal set of source files that exhibit the 
problem?

Cheers

Dave