@property and HeaderDoc
@property and HeaderDoc
- Subject: @property and HeaderDoc
- From: Jerry Krinock <email@hidden>
- Date: Mon, 20 Oct 2008 17:38:10 -0700
The scripts menu in Xcode has some nice macros for generating
HeaderDoc comments for classes, methods, etc. Some of them need
improvement, but I've gotten so that I use them every day.
But they don't know how to handle @property declarations.
As far as the programmer is concerned, even though they may be
generated at run-time or whatever, an @property declaration states the
existence of a getter and (unless readonly) a setter. Correct? So,
would it make sense to have a menu script which would generate
accessor method documentation from @property declarations? When I
design a non-trivial accessor, writing documentation helps me to make
fewer mistakes.
Has anyone thought about making HeaderDoc support @property
declarations? Besides a new Xcode menu script to generate the
HeaderDoc comment, I believe that the HeaderDoc generator tool would
also need some code added to parse the declaration itself.
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