Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Jason Swain <email@hidden>
- Date: Sat, 9 Jul 2005 10:34:49 +0100
The problem with categories is that you don't know that they exist.
It was one of the things that I had trouble with when I started
Cocoa. Categories are a great language feature, but as you say they
do make documentation challenging.
As has already been suggested, and what JavaDoc does is that the API
docs should have in the table at the top an additional section which
lists all known Categories of the class, and another section for
subclasses. So for example NSString would list NSStringAdditions and
a new user would have a link to follow at least.
Jason
On 9 Jul 2005, at 07:27, mmalcolm crawford wrote:
On Jul 8, 2005, at 11:14 PM, Guy English wrote:
That's not really a critisism - I think Objective-C categories
present a bit of a unique challenge for doc writers is all. :)
Indeed -- and this is an issue that has come up on several
occasions. Again feedback on how this might be better presented
would be useful...
mmalc
_______________________________________________
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
Jason Swain
email@hidden
mobile +44 7917 524 192
_______________________________________________
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