Re: Tips on Reading TFM?
Re: Tips on Reading TFM?
- Subject: Re: Tips on Reading TFM?
- From: Matt Rollefson <email@hidden>
- Date: Mon, 14 Jan 2002 13:08:58 -0800
A built-in feature of Project Builder that most people seem unaware of
would help you here. Specifically, the class tab. Project Builder has a
class tab that is populated from the information provided by the
compiler when your project is built. The class tab will list all methods
of a particular class, regardless of whether they were implemented in a
category from another framework or in the class itself. You can also
configure the class tab to display inherited methods, which can be quite
handy. 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. (Warning: In the December release of the tools,
and earlier, methods added via categories from a different framework
will not show up as having documentation, even though it does exist,
because of a specific bug in our tools and the way we generate the
markers for these methods. This bug will be fixed in a future tools
release.)
In general, we're trying to make Project Builder a convenient way to
find all the documentation you need. The fact that Project Builder can
do focused symbol searches makes it much more convenient for finding API
reference than just general text searches, and we aim to refine that
functionality in the future. There are still some specific bugs, but
we're looking to address as many as we can for the next tools release.
If you haven't tried using Project Builder for documentation access,
please give it a try and send us feedback about how well it works, what
ways it doesn't work for you, and ways in which you'd like to see it
improved.
By the way, if you have typed a method or class name in your source code
and want to see the documentation for it, just option-double-click on it.
Matt Rollefson (Rollie)
Manager: Cocoa & Developer Tools
Technical Publications
On Saturday, January 5, 2002, at 03:06 PM, Tom Harrington wrote:
I wonder if anyone has some useful tips on locating the information you
need in Apple's docs.
I'm new to Cocoa. Today I wanted to use NSBundle to load a nib file
which is located in the application's "Resources" directory. Looking
at the NSBundle docs (and those of its superclass NSObject) showed no
nib-specific methods. So, I spent a most of the morning trying to make
things like NSBundle's +bundleWithPath work, with much frustration and
ultimately no luck.
While looking up something else I noticed that the Appkit docs include
a second NSBundle entry. I hadn't even bothered to look for this in
the Appkit docs, because NSBundle is a Foundation framework class, and
I'd already found it's doc page, or so I thought. These docs include
the +loadNibNamed method, exactly what I needed.
Obviously I'm not grasping the organization of the documentation very
well; how would a more-experienced Cocoa developer think to locate
something like this?
-- Tom Harrington, Cybernetic Entomologist
email@hidden
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.