RE: API documentation?

Subject: RE: API documentation?
From: Anne Robotti <Anne -dot- Robotti -at- radisys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 7 May 2001 10:34:10 -0400

> I use tools to extract (at the very least) the code
> prototypes from the
> code. This assures me of their accuracy. In some cases, I
> also extract code
> comment blocks. (I've been given permission to modify code comments.)
> Material about how to use the API is maintained separately.
> In other words,
> the sequence that code items should be created/called in, special
> techniques, etc.

Glen, what tools do you use to extract the code prototypes
and comment blocks?

I'm also working on documenting some APIs, and I'm feeling
a little out of my league. Can you provide some pointers on
"don't miss" information, so that I can make sure it gets in
my outline?

I'd be eternally grateful!



*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at or info -at- devahelp -dot- com

Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See or 800-463-6627 for more about our solutions.

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 for more resources and info.


Previous by Author: RE: tool nonsense (gearing up to be a tech writer)
Next by Author: Style Manuals?
Previous by Thread: RE: API documentation?
Next by Thread: RE: API documentation?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads