Trumphurst Ltd.

DocClass

Automatic documentation generation from C++ header files

Docclass is a simple C++ program which reads in C++ header files, and outputs documentation describing the class hierarchy, methods, inherited methods etc.

All output is now through an OutputProcessor class, which can be subclassed if you want fancy printer output.

Docclass has a rather dumb parser, but it should cope with reasonably sane C++ class declarations. It understands comments, and tries to group the comments with the appropriate class or method.

Docclass does not require templates, or nested classes, as many people have C++ compilers which don't support them. With any luck, it should understand them a little in the code it analyses, though.

DocClass is known to compile under Zortech C++, Borland C++ and GNU C++.

Docclass is Copyright (c) Trumphurst Ltd. I have made it available on the Internet for personal use only. Please do not use it in a commercial situation (except for testing to see if it is suitable) without first obtaining permission by contacting us.

Trumphurst Ltd. reserve the right to remove the program from public distribution at any time.

Please note that I originally called this program "classdoc", but that name conflicts with the classdoc package written by dag@control.lth.se (Dag Bruck). His package, written in AWK, produces UNIX-style manual pages from C++ class headers. If you are interested in automatic documentation, you might want to look at this too.

Another program which may be of interest is the c2man package, written by greyham@research.canon.oz.au (Graham Stoney) available via ftp from any comp.sources.misc archive, in volume42.

For more information on any of Trumphurst's products and services, please


This page, and all contents, are Copyright © 1997-2017 by
Trumphurst Ltd.
The Willows
Canalside
St. Martins Moor
Oswestry
Shropshire
SY10 7BH
England.
Contact us
www.trumphurst.com is hosted by JumboCruiser.