Re: Online Documentation
Re: Online Documentation
- Subject: Re: Online Documentation
- From: Ben Dougall <email@hidden>
- Date: Wed, 25 Jun 2003 12:17:05 +0100
On Wednesday, June 25, 2003, at 11:05 am, Oliver Donald wrote:
I think we need something more organised than a FAQ for a subject as
large
as Cocoa. I use a few documentation sites for various things, and my
favourite by a long way is the PHP manual at http://www.php.net. For
each
function you have nicely formatted manual entry, but then you have
lots of
user contributions listed afterwards (see the 'fopen' example
http://uk.php.net/manual/en/function.fopen.php).
I think that a Cocoa 'manual' layed out like this would be incredibly
useful. Have sections for each object, and then subpages for the
object's
methods. For each method list the standard Apple documentation, but a
little
more standardised, ie, wether or not objects returned are autoreleased,
wether data is copied or referenced, stuff like that that confuses
noobs
like me.
After that people can post their tips/tricks/pitfalls/general comments
etc
etc. These comments could even rated.
Any thoughts?
sounds good to me. i've used that php manual quite a bit - i found the
user comments more useful than the manual entries themselves very
often. it'd be very handy.
for example i was looking at the NSSet page
<
http://developer.apple.com/documentation/Cocoa/Conceptual/Collections/
Concepts/Sets.html#//apple_ref/doc/uid/20000136/CJBDHAJD> yesterday,
and i think, although i'm not knowledgeable enough to be absolutely
sure, that there's a glearing great hole in that page.
it starts off:
"A set is an unordered collection of objects. An NSSet is a static
unordered collection of objects. You establish a static sets entries
when its created, and..".
a dictionary is an unordered collection of objects right? i believe an
NSSet's main distinction is that there can't be duplicates. so they're
collections of distinct / unique objects? and that'd be worth
mentioning i think on a page about NSSets i think! (if i'm right that
is). that page entirely fails to mention or even hint at that from what
i can see. that sort of thing would get sorted out very quickly if
user comments were an option.
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.