Re: Comments & Documentation (was Re: semantics of init)
Re: Comments & Documentation (was Re: semantics of init)
- Subject: Re: Comments & Documentation (was Re: semantics of init)
- From: Prachi Gauriar <email@hidden>
- Date: Thu, 05 Jun 2003 19:55:58 -0500
On Thursday, June 5, 2003, at 06:58 PM, Wade Tregaskis wrote:
<snip />
While I'm on the documentation side, what alternatives are there to
AutoDoc for generating HTML documentation? I like the Apple style, if
only because it's the 'standard', but the idea of having to fully edit
the AutoDoc-generated files kinda mutes most of the point of using
AutoDoc in the first place.
Apple HeaderDoc can do C, C++, and Obj-C files. As the name implies,
all the comments go into your header, which many prefer to putting the
comments in the source file itself. The format of the comments in your
code is similar to JavaDoc, though not as good IMO. HeaderDoc should
already be on your machine, so check out
/Developer/Documenation/DeveloperTools/HeaderDoc/ for info on how to
use it. It's pretty simple, but the HTML output isn't as pretty as
AutoDoc.
-Prachi
_______________________________________________
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.