Re: HeaderDoc style for getter/setter pairs
Re: HeaderDoc style for getter/setter pairs
- Subject: Re: HeaderDoc style for getter/setter pairs
- From: Jerry Krinock <email@hidden>
- Date: Wed, 26 Dec 2007 17:37:57 -0800
Since I've received no solutions from the other side, and after
discovering another quandary, I decided to take Steve's advice and do
it the revolutionary way.
The new quandary is KVC. KVC-compliant properties can be changed
directly, via bindings. Therefore, explaining the ^effect^ of an
property ^value^, in the documentation of the setter (or getter) would
be like documenting the interior of a house in a section titled "Front
Door". What if someone comes in the back door or the side door?
Don't they see the same interior?
So, what I am doing instead is this:
1. The ^effect^ of each property (loosely, instance variable) is
documented in a list of "properties" in the description for the class.
2. Documentation for each getter consists of a statement that it is
"the getter for ivar foo, and an indication of any copying or
dependencies involved in producing the return value.
3. Documentation for each setter consists of a statement that it is
"the setter for ivar foo", and a discussion of any other side effects
(other than assigning the ivar value) which occur when the setter is
used.
_______________________________________________
Cocoa-dev mailing list (email@hidden)
Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden