I am in the process of adding doxygen docs to the make system for a
moderate sized project (C/C++).
I was expecting that by setting:
ENABLE_PREPROCESSING = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH = TOP1/include TOP2/include
INCLUDE_FILE_PATTERNS = *.h
...then the header files containing the C++ class definitions would be
incorporated, and their documentation included. But all I get is the
.cc source files, and no class structures.
Can I get the stuff in the header files brought into the doc?
Note that in this case the class headers are in subdirs off
"TOP2/include", eg "TOP2/include/proj1" and "TOP2/include/proj2". They
are included as "#include "proj1/thing.h" etc.
When I add the include subdirs to the INPUT list, I get the desired
documentation (all the class structures and inheritance, all the member
function definitions etc).
Why is this undesirable? Because the author of the Makefile will have
to know all the include dependancies of the source being documented. I
already automate this for compilation (using g++ -MM). We really dont
want to blindly INPUT all the super-projects include files, since we are
only documenting a sub-project at a time.
I suppose I could do something to manipulate the existing dependancy
lists (from g++ -MM), to accumulate a list of all quoted header
dependancies on the source in the sub-project directories... Messy.
I am using Doxygen 1.2.1 which came with RH7.0. If I have to rely on an
u/grade, then all machines intending to use our make system would have
to u/g as well (ie, at least a compatible RPM).
Si.
--
Simon A Watts
Software Engineer
Marconi Medical Systems
mailto:sim...@ma...
tel: +44(0) 1252 747 311
|
