Re: Tips on Reading TFM?
Re: Tips on Reading TFM?
- Subject: Re: Tips on Reading TFM?
- From: Matt Rollefson <email@hidden>
- Date: Wed, 16 Jan 2002 13:49:24 -0800
Disclaimer: This is not a supported feature as of now. If it goes away,
you've been warned.
That said, PB makes a rendezvous with documentation by indexing
//apple_ref entries. You can look at the HTML documentation files to get
an idea of the format of these entries. The documentation for HeaderDoc
may also include a spec; I don't recall. PB generates its index at
install time by running /Developer/Tools/pbhelpindexer. The list of
directories to index is stored in
/Developer/Documentation/Help/Developer Help Center in a property list
file with an extensino of .pbHelpIndexerList. If you put in your own
//apple_ref entries, correctly formatted, and then index them by putting
them somewhere pbhelpindexer looks, you should see book icons appear for
your documented methods, classes, etc.
Rollie
On Monday, January 14, 2002, at 01:24 PM, Thomas Deniau wrote:
Le 14/01/02 22:08, Matt Rollefson disait :
Next to the classes, and the methods, you'll see a book icon for
those methods that have documentation. Just click on the book icon to
see the documentation.
Can we use this to document our own classes ?
(useful in open source projects ...)
--
Thomas Deniau