RE: help: tips from c++ api writers

[Megan Golding <mgolding -at- secureworks -dot- net>]

[Carol Chung] has been "asked to document an api on short
notice...If I have to, I heard that you can extract info from
header files."

---

Carol,

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.

Good luck with your project!

Regards,
Megan Golding
SecureWorks, Inc.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** 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.