On Tuesday, August 5, 2003, 12:38:20 AM, Austin wrote:
> A year ago, I talked Dave into adding some new tags to RDoc because it made
> it easier for me, and it removed the need for "file-level" documentation. If
> you look at my text-format documentation, you'll see these at the beginning
> of the source file:
> # :title: Text::Format
> # :main: Text::Format
> These correspond to the appropriate command-line flags (and the command-line
> should override these; I haven't really tried that). :main: specifies the
> first page that will be shown, thus you could do:
> # :main: Net::IMAP
> And the documentation generated for Net::IMAP will appear first.
> It is *not* clear what will happen if there are multiple, conflicting :main:
> tags (if you're generating the documentation for all of net/* at once). Then
> again, I don't ever use file-level documentation.
Thanks for the tip. I looked at the text-format code/doc and was
going to ask you to clarify, but I guess it's pretty simple after all.
We'll have to see the effect when a whole lot of files are RDoced at
once.
Gavin
|
