Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Dietmar Planitzer <email@hidden>
- Date: Sat, 9 Jul 2005 23:09:00 +0200
On Jul 9, 2005, at 6:17 PM, Guy English wrote:
On 7/9/05, Dietmar Planitzer <email@hidden> wrote:
And in any case let's keep in mind that even from the viewpoint of the
ObjC runtime, categories have basically no relevance after they are
loaded into an executable. All methods defined in an category are
merged into the class which the category overloads right at the time
the category gets loaded.
[lots of good stuff snipped]
What happens for things like NSStringDrawing though? Those methods
*aren't* part of NSString unless you're working with AppKit. Now,
admittedly, most people work with AppKit so it's not a great example
but the point remains the same: Additional frameworks can add methods
to classes in other frameworks. How do you document this interaction?
Just like it is done today. The drawing methods belong to the AppKit
and thus should be documented in the AppKit section. The NSString
Foundation docs contain a pointer to the AppKit extensions which makes
everything clear.
However, in the case of the NSWindowScripting category separating the
documentation doesn't make sense. Both NSWindow and NSWindowScripting
are implemented by the AppKit as it is today. In both cases we're
dealing with methods belonging to the same class, namely NSWindow.
Further, NSWindowScripting is not an informal protocol in the sense
that you as an application developer would be expected to implement any
of the methods declared in that protocol unlike say
NSDraggingDestination That's why I would not even call it an informal
protocol. Thus, having NSWindowScripting in the AppKit protocol section
does not make sense. At least not in my view.
Regards,
Dietmar Planitzer
_______________________________________________
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