Re:Help required - Using tools for API documentation
Subject: Help required - Using tools for API documentation...
From: "Paresh, Naik (IE10)" <Paresh -dot- Naik -at- honeywell -dot- com>
Date: Mon, 14 Apr 2003 17:44:26 +0530
Has anybody out there tried auto-generating API or SDK documentation?
Apart from general advice on this, I am specifically looking for answers to
the following questions-
* Many commercial tools like TLB2HTML etc. take the output files of
the solution like TLBs , dlls and so on as inputs to the documentation tool.
* Many of the APIs that I need to document are C++ and not COM based -
therefore no typelib is available. How to take care of this? * Typelibraries include all the interfaces they depend on. Therefore,
most of the document generated is for interfaces that are provided by Microsoft.
Is there any smart way to limit the output to the interfaces contained in
* Is there a way to add descriptions, in the IDL source code, for
methods and parameters? Looking at MSDN help it appears that this is
for methods (using the 'helpstring' attribute) but how about adding
descriptions for parameters?
* The method of Tools > Build Comment Web Pages in MS VisualStudio
.NET appears to be one way out. However the .NET help says Visual C++
provides limited support for XML documentation comments and C# fully
* Does anyone know; what they mean by 'limited 'support?
* What's the smart way to import thousands of interlinked HTML pages,
generated this way, in RoboHTML to generate .chm file?
The File > Import > HTML files option in RoboHTML does not
allow more that 60-70 pages to be imported at a time.
* Apart from Doxygen , which other tools take source (and not output)
files as input?
* Has anyone tried Document!X? It appears it works well for VB.NET,
any reports of it with C++?
Thanks in advance,
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.
Previous by Author:
Re: Help required - Using tools for API documentation
Next by Author: Re: Tech writer/ Documentation Specialist
Previous by Thread: Re: Help required - Using tools for API documentation
Next by Thread: Levels of Edit: how are they defined/applied by technical editors?
Search our Technical Writing Archives & Magazine