Re: Source code documentation systems for Cocoa (and C)
Re: Source code documentation systems for Cocoa (and C)
- Subject: Re: Source code documentation systems for Cocoa (and C)
- From: Patrick Machielse <email@hidden>
- Date: Tue, 02 Dec 2003 15:02:48 +0100
op 01-12-2003 21:59 schreef Scott Anguish op email@hidden:
>
On Dec 1, 2003, at 11:05 AM, Patrick Machielse wrote:
>
>
> I'm looking for a documentation system to annotate my Cocoa code.
>
>
>
> I've looked into HeaderDoc, which comes installed with the devtools, but I am
>
> not really impressed.
>
>
you may wish to look at autodoc, http://www.clindberg.com
I've had a look at it, but I'm not sold.
The are some nice advantages over HeaderDoc:
- parses code, instead of just comments.
- simpler documentation tags.
- more output formats.
But there are also plenty of downsides:
- ignores C api. (n.b. I updated the message subject)
- no frames in html output.
- no table of contents, just a bunch of .html files?
The last points could conceivably be solved by some clever post processing
code.
Also, the program has not been updated for 2.5 years. (tested on OS X public
beta?) so there seems to be little hope for improvement.
So for now it seems I'm stuck with the cumbersome ways of HeaderDoc.
Ideally I would like to have documentation output in the style of JavaDoc,
with all it's rich information like inherited methods, cross references,
etc. But since even Apple's documentation isn't up to that level yet that
may be wishing for too much. I heard it is possible to write plug-ins for
JavaDoc though, so maybe there is a possibility after all?
Patrick
_______________________________________________
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.