Doc access for Cocoa
Doc access for Cocoa
- Subject: Doc access for Cocoa
- From: Ronald Hayden <email@hidden>
- Date: Fri, 9 Nov 2001 16:04:28 -0800
I just joined this list, after hearing about some complaints related to
doc access for Cocoa. This is something we've been working hard on, and
there may be some features people are unaware of.
If you are using ProjectBuilder, try the following:
INDEXING
First of all, make sure indexing is turned on for your project. Most
doc access features don't work without it.
FIND
To find any particular piece of API, go to the PB Find panel, accessible
through the tab visible in the top half of your PB window.
In the area where you specify options for your search, set the lower
popup to Definitions. (This seems the most obscure part of things to
me, and I want to check with the PB folks to see if we could have any
kind of search work for doc.)
When you do the find, if you click on the text portion of the hit, you
are jumped to the header file at that API. If you click on the book
next to the hit, you are jumped to that location in the documentation.
As you'll see further down, the book is a consistent UI element meaning
"click this for doc".
CLASS BROWSER
Frequently, the Class Browser is the most interesting way to scan
through a framework. To see the browser, click Classes in the vertical
tabs on the left side of the window.
This gives you a list of all classes created for your project (in blue),
and all classes in Frameworks you are linked to. Clicking on the class
name jumps you to that header, clicking on the book jumps you to the doc.
Also, selecting a class brings up a list of the class's methods in a
lower pane, also hooked to the header and the doc.
We are in the process right now of prioritizing what our next set of doc
access features should be. Feel free to post suggestions here or email
them to me.
-- Ron Hayden, Senior Tools Manager & Darwin Doc coordinator guy