From: Sam Roberts <sroberts@...>
Date: 2003-03-09T10:59:29+09:00
Subject: rdoc - how to exclude internal APIs, and use :title: and :main:?

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
    # A thing.
    THING = "do-de-do"
  end

  # internal docs
  def A.func
  end
  end
#++

  public

  # .. the public API


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.

In the above example, A::B is showing up in the Classes list (but not
A::B::THING!). I don't want to see it.

Also, A.func is showing up, and I don't want to see it either.

What's the right way?


++ Q2


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.

I tried a few variations around

  --main=Rfc2425::Vcard, --main=Vcard, --main=Rfc2425.Vcard

that didn't work, either.

--title does work, but I'd like to keep the title in the doc.

What am I missing?


Thanks,
Sam