35_gen_dox.b File Reference
Calls doxygen with the specified input directory and then copies generated files where they need to go for later processing.
More...
Go to the source code of this file.
Detailed Description
Calls doxygen with the specified input directory and then copies generated files where they need to go for later processing.
-
Parameters:
-
dox_path |
A portion of the path used to distinguish the project. The final destination is assumed to be cref_<dox_path>. In addition, it is assumed that a related <dox_path>.dox configuration file for doxygen exists in the directory from where this was called. |
master_nav |
The name of an master HTML file that has common HTML fragments which are to be inserted in all generated HTML pages. |
master_proj |
The name of the project_toc.txt file that defines all directories and their associated names, pdf files, and document numbers. |
-
Limitations and Caveats:
-
This calls both 55_nav_gen.b and 56_nav_script.b with the information passed into this script. These were two steps that were often forgotten. Doxygen does not generate HTML based on the master navigation file, so 55_nav_gen.b forces the insertion of the standard tags.
Likewise, this script by itself does not make sure that the master TOC script file is updated. As such, after copying over the mini-index and mini-TOC files to a known location, this goes ahead regenerates the master TOC.
It does not regenerate the master index, because that is much more time-consuming.
-
Author:
-
Glenn C. Maxey
Definition in file 35_gen_dox.b.
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-script-hcr-02