Lists

Terms and Conditions
Lists hosted on this site
Email the Postmaster
Tips for posting to public mailing lists

HeaderDoc style for getter/setter pairs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

HeaderDoc style for getter/setter pairs

Subject: HeaderDoc style for getter/setter pairs
From: Jerry Krinock <email@hidden>
Date: Fri, 21 Dec 2007 21:21:02 -0800

I believe that instance variables accessed with getter/setter method pairs should be described only once in class documentation.

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?

Also, HeaderDoc would be nicer if it would group getters with their corresponding setters. Does anyone know a way to make it do that?

Jerry Krinock
_______________________________________________

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


Follow-Ups:

Re: HeaderDoc style for getter/setter pairs
From: Scott Anguish <email@hidden>


Prev by Date:
Re: Disabled PopUpButton With Action

Next by Date:
Re: Disabled PopUpButton With Action

Previous by thread:
RE: NSTextView custom cursor

Next by thread:
Re: HeaderDoc style for getter/setter pairs

Index(es):

Date
Thread