From: Dave Thomas <dave@...>
Date: 2003-03-09T12:11:22+09:00
Subject: Re: rdoc - how to exclude internal APIs, and use :title: and :main:?


On Saturday, Mar 8, 2003, at 19:59 US/Central, Sam Roberts wrote:

> I'm sorry if I'm missing the obvious, but i'm staring at the docs, and
> exerimenting, and it I'm not making progress.
>
> ++ Q1
>
> I have
>
> module A
>   private
>   module B
>   end
> def A.func
>   end
>   end
> ...
> I don't want A::B to show up in the API docs at all, its just a
> container I use for implementation details. A.func is also internal.
>
Neither B nor A.func in private in module 'A' -- you'd have to put the 
private in the metaclass to do that.

Your best bet is probably to use :nodoc: on the internal module and the 
internal private methods.



> What is the syntax for --main? I've tried some various things, but they
> don't seem to do what I want!
>
> I have
>
> # :title:vcard - a library to manipulate vCard 2.1, vCard 3.0, and RFC 
> 2425 objects
> # :main:Rfc2425::Vcard
> module Rfc2425
>   class Vcard
>   end
>
>   ...
> end
>
> And I want the Vcard class to be the main page.
>
> I'm getting :title: ignored, and "vcard.rb:50:6: Unrecognized directive
> 'main'" for main.

Strange - both worked for me when I tried them here. Perhaps you are 
not running the latest RDoc? I suggest getting the CVS version from 
SourceForge and trying again.

Also, the 'main' directive sets the main page to the file that contains 
the given symbol, which might not be the effect you're expecting.

Sorry


Dave