From: John Wilger <johnwilger@...>
Date: 2004-11-13T04:42:09+09:00
Subject: RDOC Question -- including parent class accessors, and linking other classes

Hello,

I apologize for the cross-post, but I was advised that this list is a
lot more active than the ruby-doc list and I might get an answer
faster by posting my question here. Please see below:


On Fri, 12 Nov 2004 14:17:59 -0500, John Wilger <johnwilger@gmail.com> wrote:
> Hello,
> 
> I have acouple of  quick questions regarding RDOC, but I can't seem to
> find the information anywhere in the RDOC documentation (or even with
> a Google search).
> 
> Lets say I have a parent class like:
> 
> class ParentClass
>   attr_reader :parent_reader
> end
> 
> And I have a child class like:
> 
> class ChildClass
>   attr_reader :child_reader
> end
> 
> 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".
> 
> 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?

-- 
Regards,
John Wilger

-----------
Alice came to a fork in the road. "Which road do I take?" she asked.
"Where do you want to go?" responded the Cheshire cat.
"I don't know," Alice answered.
"Then," said the cat, "it doesn't matter."
- Lewis Carrol, Alice in Wonderland