Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Ross Carter <email@hidden>
- Date: Mon, 11 Jul 2005 07:38:08 -0400
I quite like the Cocoa documentation. One small suggestion is to
consider normalizing the way in which method descriptions designate
the default return value. I've noticed the following variations:
1. The default value is noted in the setter method but not the getter
method. Example: NSTextView isRulerVisible/setIsRulerVisible.
2. Default values are provided for some methods and not provided for
similar methods. Example: NSParagraphStyle paragraphSpacingBefore
(default is 0.0) and paragraphSpacing (default not specified).
3. The default value is provided somewhere other than in the method
description. Example: NSButton bezelStyle (the default value is
designated in the Constants section).
4. The default value is described in terms other than its actual
return value. Example: In NSPopUpButton preferredEdge the description
says, "For pull-down menus, the default behavior is to display the
menu under the receiver," but does not state that the default return
value is NSMaxYEdge.
This is just a small suggestion. Overall I find that the occasions
when I struggle with Cocoa documentation are far outnumbered by the
occasions when I find exactly what I want.
Ross
_______________________________________________
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