Re: HeaderDoc style for getter/setter pairs
Re: HeaderDoc style for getter/setter pairs
- Subject: Re: HeaderDoc style for getter/setter pairs
- From: Scott Anguish <email@hidden>
- Date: Sat, 22 Dec 2007 01:32:12 -0500
On Dec 22, 2007, at 12:21 AM, Jerry Krinock wrote:
I believe that instance variables accessed with getter/setter method
pairs should be described only once in class documentation.
Gack
However, HeaderDoc likes you to have a description with each method,
which would be redundant for getter/setter pairs. I'm thinking
maybe I should list and describe the instance variables in the class
description. Is there a better style?
Assuming you mean for public consumption? It's best to go the way we
do now (although writing these daily that may have been pounded into me)
getters and setters can have different usages notes that are complex
to note if they're together.
Having had to write more generic descriptions that apply to both get
and set situations (for @property support in Objective-C 2.0 class
documentation) I find that much harder to get 'right'.
Also, HeaderDoc would be nicer if it would group getters with their
corresponding setters. Does anyone know a way to make it do that?
As opposed to alphabetical order?
_______________________________________________
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