TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Automatically generating C/C++ function documentation
Subject:Automatically generating C/C++ function documentation From:Chris Knight <knight -at- ADA -dot- COM> Date:Mon, 20 Apr 1998 13:35:26 -0700
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
Consultant, Technical Communication Architect
Vancouver BC, Canada
(currently at Applied Digital Access,
E-mail: knight -at- bcg -dot- ada -dot- com Phone: 604-415-5886 Fax: 604-415-5900)
Opinions expressed are my own, not ADA's
