Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Scott Anguish <email@hidden>
- Date: Sat, 9 Jul 2005 03:44:53 -0400
On Jul 9, 2005, at 2:33 AM, James Andrews wrote:
Actually, I didn't dig in in NSWindowScripting.h. I didn't know
NSWindowScripting existed, as my Cocoa/Obj-C books never talked
about them. I found it defined in the NSWindow section of the
"Cocoa in a Nutshell" book where they say it's an Accessor Method
of NSWindow (though thumbing through and finding NSWindowScripting
it is also listed there).
Right, well, in this case I'd say it's an issue with Cocoa in a
Nutshell.
NSWindowScripting is an informal protocol, and those are
separated out as categories.
As for "I think Objective-C categories present a bit of a unique
challenge for doc writers is all".
writing the doc isn't any different...
I think providing the inherited informal protocols for things
would be good, Right now we document the formal protocols in the
'table' at the top of the class.. the name of the protocol and, if it
is from a superclass, the superclass in brackets. The same thing
could be done with informal protocols.
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden