Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Prachi Gauriar <email@hidden>
- Date: Sat, 9 Jul 2005 11:21:24 -0400
On Jul 9, 2005, at 8:16 AM, Dietmar Planitzer wrote:
On Jul 9, 2005, at 9:44 AM, Scott Anguish wrote:
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.
...
Further, applying this logic to all Cocoa classes, we get a
problem: If methods declared in a category are supposed to be
documented in their own document, why does this not apply to
classes like NSArray, which are split up implementation-wise into
many different categories, but still all methods are described
together in one single reference document ?
I don't think Scott was suggesting that all categories get their own
documentation. He was saying that all informal protocols (categories
of NSObject) get their own documentation. He then suggested that
classes with default implementations of those protocols have links to
those protocols' documentation.
This makes sense, since many classes can have default implementations
of informal protocols, and providing the same documentation in
several places is wasteful and difficult to maintain.
-Prachi
_______________________________________________
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