From: Jan Svitok <jan.svitok@...>
Date: 2007-01-11T04:10:34+09:00
Subject: Re: rdoc for 1.8.5 not creating Module docs?

On 1/10/07, James Britt <james.britt@gmail.com> wrote:
> When running rdoc over the current 1.8.5 source, the resulting HTML file
> set does not include docs for Module.
>
> If I run rdoc on just object.c, then Module appears in the class index
> and a Module.html file is created.  But rdoc'ing the entire source
> directory omits it.
>
> Oddly, I get a classes/Module.src/ directory, with numerous Module
> source HTML files, but no Module.html, and no listing for Module in the
> class list.
>
> Has anyone else seen this?
>
> It appears  related to the :stopdoc directive in the Module definition
> in lib/yaml/tag.rb.
>
> Removing that directive brings back the Module.html file, though it ends
>   up including docs from tab.rb.
>
> What would be another  way to hide the documenting of the tag.rb file
> without boinking the main Module docs?

adding :startdoc: at the end of the Module def?

From rdoc/README:

:stopdoc: / :startdoc:
    Stop and start adding new documentation elements to the current
container. For example, if a class has a number of constants that you
don't want to document, put a :stopdoc: before the first, and a
:startdoc: after the last. If you don't specifiy a :startdoc: by the
end of the container, disables documentation for the entire class or
module.