Self-documenting source code

GALLOWAY gg10 at prism.gatech.EDU
Tue Nov 13 05:12:59 AEST 1990


Is anyone aware of any packages or systems which extract documentation
for use in troff-format man pages or latex documents directly from the
C source code?

I am thinking along the lines of a token based system of embedding keywords
nto comments which are extracted some sort of parser.

One use would be to extract descriptions and prototypes for library functions.
It would be a lot easier to ensure that the documentation is up to date if
it is kept close to the actual code.

Any thoughts or pointers would be appreciated.

Thanks,

Greg Galloway
Georgia Institute of Technology



More information about the Comp.lang.c mailing list