TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Help required - Using tools for API documentation
Subject:Re: Help required - Using tools for API documentation From:Chris Gooch <chris -dot- gooch -at- lightworkdesign -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 14 Apr 2003 15:36:21 +0100
Paresh wrote:
+++
Has anybody out there tried auto-generating API or SDK documentation
<snip>
Apart from Doxygen , which other tools take source (and not output)
files as input?
+++
I've used Perceps quite successfully - it's a free set of Perl scripts
which produce html output from scanning C / C++ files (works best
with C++ as it does a good job of documenting the class hierarchy).
The output is quite configurable, as is the commenting format. You'll
need to get Perl running on your machine to use it.
Personally I've not looked at Doxygen so I can't say whether it is
better or worse than Perceps (but I've heard good things about
Doxygen in the past).
HTH,
Chris.
Christopher Gooch, Technical Author
LightWork Design Ltd., Sheffield, UK
www.lightworkdesign.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here: http://www.ehelp.com/techwr-l/
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.