Re: Online Documentation
Re: Online Documentation
- Subject: Re: Online Documentation
- From: Neil Earnshaw <email@hidden>
- Date: Thu, 26 Jun 2003 15:16:38 +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?
A truly excellent idea, especially the attached comments.
DISCLAIMER: The information contained in this e-mail is confidential
and may
be privileged. It is intended for the addressee only. If you are not
the
intended recipient, please delete this e-mail immediately.
The contents of this email must not be disclosed or copied without the
sender's consent. We cannot accept any responsibility for viruses, so
please
scan all attachments.
The statements and opinions expressed in this message are those of the
author and do not necessarily reflect those of the company. The
company does
not take any responsibility for the views of the author.
_______________________________________________
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.
Neil Earnshaw
Consultant Software Engineer
Object Software Engineers Ltd
email@hidden
Tel : 01747 854 852
Mbl : 07870 209 102
_______________________________________________
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.