HeaderDoc - fixes or alternatives
HeaderDoc - fixes or alternatives
- Subject: HeaderDoc - fixes or alternatives
- From: Wade Tregaskis <email@hidden>
- Date: Tue, 3 Feb 2004 22:58:28 +1100
I'm getting very tired of HeaderDoc's many bugs, so I'm looking for
either fixes or alternatives. I had applied a few of the former to the
installed headerdoc2html script under 10.2.8, but of course the 10.3
installation hosed that. My own fault for not keeping a copy I guess.
I'm not sure I can be bothered refixing them in the newer version, so
I'm now I'm really looking for clear alternatives.
I don't feel like changing the documentation format for what I've
already done (some 10,000 lines of documentation), so I'm hoping to
find something that is HeaderDoc compatible. I've looked at what was
called "autodoc" [from memory], but the output from that was rather
gross. Does anyone have templates for it to match or better the normal
HeaderDoc output? It also had a few bugs from memory too.. any comments
on the latest version?
I understand in the C/C++ world Doxygen (or some similar spelling) is
used predominantly, but when I used it for a work project recently I
found it both limited and even worse than autodoc in it's output format
- in fact I eventually hacked up a version of headerdoc to work under
Red Hat, despite it's problems, just to save myself from it.
Are these three scripts/apps really the only significant in-code
documenters available? If so, what alternative methods of developer
documentation have people pursued, and to what level of satisfaction?
I really like the convenience of writing structured documentation in
the header files themselves, but hate having to search through the
header files (as opposed to indexed HTML files) to read that
documentation. I've tried out-of-code documentation via several
approaches in years gone past, but always found them too unwieldy or
difficult to manage.
Wade Tregaskis
-- Sed quis custodiet ipsos custodes?
_______________________________________________
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.