From: David Vallner <david@...>
Date: 2006-08-30T10:26:06+09:00
Subject: Re: rdoc problem

Rick DeNatale wrote:
> On 8/28/06, David Vallner <david@vallner.net> wrote:
>> Only that one is supposed to be there. Rdoc looks for file-specific
>> documentation as the first documentation segment in the file - it's not
>> supposed to process every comment in the file.
> 
> Actually it's supposed to process the first comment block before each
> "major element" in the file.  The pickaxe 2nd ed. "defines" major
> elements as (classes, modules, methods, attributes, and so on).
> 
> I'm not sure where the official list of major elements can be found.
> 

Note the "file-specific". The file itself being the documented element.

Though I admit what I said might have been confusing at a glance.

David Vallner