Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Scott Anguish <email@hidden>
- Date: Sun, 10 Jul 2005 00:07:08 -0400
On Jul 9, 2005, at 4:58 PM, Dietmar Planitzer wrote:
On Jul 9, 2005, at 10:06 PM, Scott Anguish wrote:
On Jul 9, 2005, at 8:16 AM, Dietmar Planitzer wrote:
I don't see how breaking up the documentation of a single class
into multiple individual documents is of any help. In fact I
think, and as this sub-thread has shown, it makes it harder to
find what people are looking for. Consider again the original
problem:
We are looking for the documentation of a method that allows us
to show/hide a window.
actually, this documentation IS in NSWindow.
makeKeyAndOrderFront: and orderOut:
We are talking about the -setIsVisible: method which is definitely
not listed in the NSWindow reference, although it is a NSWindow
method.
As I said, it's actually an informal protocol. NSWindow does
implement it, and I agree (and have raised the issue internally) that
informal protocols should be listed along with formal protocols in
the class documentation.
because those aren't informal protocols.
Just like NSWindowScripting is not an informal protocol.
Actually, it is.
Informal protocol. Supports window scripting by getting and setting
standard properties and handling the Close, Print, and Save commands.
It is a category that contains the implementation of a bunch of
NSWindow methods.
that's how informal protocols are implemented. There isn't an
option in Objective-C to declare a protocol and not implement all the
methods. informal protocols allow you do to that.
Again, either the same principle is applied to all categories and
classes or to none. Inconsistency in the documentation is just as
bad as in the user interface of applications. If NSWindowScripting
is listed among protocols then so must NSExtendedArray. Both are
categories which apply to a particular class namely NSWindow and
NSArray, respectively. Both consist of method declarations and
implementations.
If you simply look at the headers, then yes the appear the
same. However the informal protocol methods are intended to be
overridden.
_______________________________________________
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