Parameter descriptions (was Re: Documentation frustrations)
Parameter descriptions (was Re: Documentation frustrations)
- Subject: Parameter descriptions (was Re: Documentation frustrations)
- From: mmalcolm crawford <email@hidden>
- Date: Sat, 9 Jul 2005 01:38:58 -0700
A quick question as the thought comes to mind:
In the Cocoa documentation, parameter descriptions are given in
sentence form (even to some extent in extreme cases, such as <http://
developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/
ObjC_classic/Classes/NSBitmapImageRep.html#//apple_ref/doc/uid/
20000347-
initWithBitmapDataPlanesCOLONpixelsWideCOLONpixelsHighCOLONbitsPerSample
COLONsamplesPerPixelCOLONhasAlphaCOLONisPlanarCOLONcolorSpaceNameCOLONby
tesPerRowCOLONbitsPerPixelCOLON>).
In contrast, the Core Foundation documentation gives individual lines
for each parameter (for example, <http://developer.apple.com/
documentation/CoreFoundation/Reference/CFNumberRef/Reference/
chapter_2.1_section_2.html#//apple_ref/doc/uid/20001209-
DontLinkChapterID_1-F11054>).
I'd be interested to know which style users prefer, and if there are
any other style that might be better still. Please reply off-list,
and I'll summarise(*).
mmalc
(*) Hmm, this reminds me that I promised to summarise something else
a long time ago, and I don't think I ever did. :-( I'll have a look
back to try to remember what it was...
_______________________________________________
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