RE: API Documentation

Subject: RE: API Documentation
From: "Richard Smith" <Richard -dot- Smith -at- windriver -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 20 Feb 2001 09:50:36 -0800

Bill McClain wrote:
<First, a general question for everybody, then stratagems for you:
Does anyone have a feel for how useful these
automatic generators have proven for developers?>

I think the tools are more useful for TWs than developers. The real value of
these tools is (IMO) the ability to parse the code and create a structured
API reference in a specified output format. That can be HTML, MIF, or
perhaps other formats.

I would reccommend that a TW work with the developer to write code comments,
since docs can be generated automatically from code. It somewhat defeats the
purpose if you have to edit generated documentation afterward.

Richard Smith

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See for more information and free evaluation downloads

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: Confusion: Can you still legally download from Napster?
Next by Author: RE: The Sub Shop Guy
Previous by Thread: Re: API Documentation
Next by Thread: RE: API Documentation

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

Sponsored Ads