Re: Automatically generating C/C++ function documentation

Subject: Re: Automatically generating C/C++ function documentation
From: "Wing, Michael J" <mjwing -at- INGR -dot- COM>
Date: Mon, 20 Apr 1998 15:48:46 -0500

The MSWord macro approach worked for me for APIs. I used OLE2View.exe to
write typelibs and OCXs to text files. I then wrote two macros. The first
converted all the functions (in the text files) to help topics. Then, after
deleting hidden functions and ensuring that the topics were in the desired
order, a second macro performed the linking. I also automated the creation
of contents files, creating individual topics, and assigning helpcontextids.

A macro approach may work if the C++ functions are visible through a browser
with print-to-text capabilities.

Mike

Michael Wing (mailto:mjwing -at- ingr -dot- com)
Principal Technical Writer
Intergraph Corporation; Huntsville, Alabama
http://www.ingr.com/iss/products/mapping/

"Humpty was pushed!"


> Indeed it can be automated, by writing macro programs in MS Word. There
> may be utilities too, but I've never heard of them.
>
> It works because source text is structured; it has to be for the
> compiler to work. What you do is take advantage of the structure to
> extract the information you want, typically declarations of types and
> functions in C, classes and methods in C++. It can be as primitive
> or as sophisticated as you want.
>
> --
> Chris Knight
>




Previous by Author: Re: What Might a Writing Test Be?
Next by Author: Re: secretary's day
Previous by Thread: Automatically generating C/C++ function documentation
Next by Thread: Contacts Wanted


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

Sponsored Ads


Sponsored Ads