From: John Wilger <johnwilger@...>
Date: 2004-11-14T01:51:08+09:00
Subject: Re: RDOC Question -- including parent class accessors, and linking other classes

My reply didn't go to the list due to the attachment I was sending to
Dave, so here it is.


On Fri, 12 Nov 2004 15:38:57 -0500, John Wilger <johnwilger@gmail.com> wrote:
> Dave,
> 
> I doubt the list allows attachments, so I put your address in the 'to'
> field as well so you can get the sample code.
> 
> On Sat, 13 Nov 2004 04:54:05 +0900, Dave Thomas <dave@pragprog.com> wrote:
> > 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.
> 
> How about including a tag like "#:document_inherited:"? This would
> include the inherited methods/accessors of the immediate parent only
> in the current class. However, if the immediate parent also specified
> the "#:document_inherited:" tag, then the child class would document
> it's grand-parent's methods/accessors as well (unless they were
> overriden down the chain), and so on, and so forth on up the line.
> 
> >
> > Could you email me a minimal set of source files that exhibit the
> > problem?
> 
> I think I figured out what is causing the problem. The class inside
> the 'lib' directory is defined within a module, but the class inside
> 'app/models' is not. Apparently RDOC will only create the link to
> other classes within its namespace if you don't specify the namespace
> explicitly. So what would the explicit namespace be for a class that
> isn't inside a module?
> 
> I've attached a paired down sample for you to look at.

-- 
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