Re: HeaderDoc misses some methods?
Re: HeaderDoc misses some methods?
- Subject: Re: HeaderDoc misses some methods?
- From: John Ashley Burgoyne <email@hidden>
- Date: Fri, 31 Oct 2003 00:32:36 -0500
The problem is that HeaderDoc has an undocumented requirement with
regard to Objective-C methods (and possibly others, I haven't done an
extensive diagnosis). If you give the method an @abstract, you MUST
give it a @discussion too. If you do not include a @discussion, the
tool will not give you any sort of feedback that it thinks anything is
missing. But it will fail to put the method in most of the generated
files (as described above), instead just printing a "0". If you have
multiple methods without a @discussion then you may see "00", "000",
etc. I'm using HeaderDoc 7.3.0, which is the current release.
I had the same experience with HeaderDoc on one of my recent projects.
If I recall, *nothing* worked properly when given an "@abstract"
without a "@discussion".
I have filed a bug with OpenDarwin Bugzilla:
http://www.opendarwin.org/bugzilla/show_bug.cgi?id=1100
Please feel free to add to it any comments from your own experience.
John Ashley Burgoyne
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.