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.
Subject:RE: help: tips from c++ api writers From:Megan Golding <mgolding -at- secureworks -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 5 Apr 2001 05:14:47 -0400
[Carol Chung] has been "asked to document an api on short
notice...If I have to, I heard that you can extract info from
I would recommend an automated tool for extracting documentation
directly from the code. At my company, the developers have
installed and are using doxygen
(http://www.stack.nl/~dimitri/doxygen/). Doxygen is free soft-
ware (GUN License).
In the past, when I documented a small API, I found the biggest
challenges were in making sure my documentation was complete and
accurate. This is very tedious work and you'll get the best
results when information is taken directly from the code.
Fortunately, tools like doxygen and javadoc
(http://java.sun.com/j2se/javadoc/index.html) make API documen-
tation much easier.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
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.