Re: Tips on Reading TFM?

FROM : Matt Rollefson
DATE : Wed Jan 16 22:42:41 2002

On Tuesday, January 15, 2002, at 05:49 PM, Tom Harrington wrote:

> Matt Rollefson wrote:
>
>> 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.
>
> Thanks, will do.  Via the ADC feedback page, I presume?

That's one avenue, or you can send me feedback directly.

>> 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.
>
> That's pretty nice, and leads to what'll be my first feedback:  There's
> no (apparent) documentation for NSRect and NSPoint.  Not that there's
> much to them, but if something like option-double-click works for some
> NS* stuff it should work for all of it, IMHO, even if that means just
> bringing up the appropriate header file so that I can see the
> definition.

There are definitely still some bugs. :) Specifically, right now the
lookup should work reliably for classes and methods (although not
delegate methods, and in the December tools release I believe methods
added by another framework are also not working -- these are quite rare,
and we have a fix for the next release). Constants and types are less
reliable; we're working on making them more so. I'd recommend filing a
bug report saying that in the case of option-double-click, if there's no
documentation PB should fall back to just displaying the header file.

> -- Tom Harrington, Cybernetic Entomologist
> <email_removed>

Rollie