DoxyPress
1.7.0
|
If your project depends on external libraries or tools there are several reasons not to include all of the source for with every run of DoxyPress.
If any of the above apply, you can use the DoxyPress tag file mechanism. A tag file is basically a compact representation of the entities found in the external sources. DoxyPress can both generate and read tag files.
To generate a tag file for your project put the name of the tag file after the generate-tagfile option in your project file.
To combine the output of one or more external projects with your own project, specify the name of the tag files after the tag-files tag in the project file.
A tag file typically only contains a relative location of the documentation from the point where DoxyPress was run. So when you include a tag file in other project you have to specify where the external documentation is located in relation this project. You can do this in the project file by assigning the (relative) location to the tag files specified after the tag-files tag. If you use a relative path it should be relative with respect to the directory where the HTML output of your project is generated; so a relative path from the HTML output directory of a project to the HTML output of the other project that is linked to.
projectA
which uses two external projects called ext1
and ext2
. The directory structure looks as follows:<root> +- projectA | +- html HTML output directory for projectA | +- src sources for projectA | |- proj.cpp +- ext1 | +- html HTML output directory for ext1 | |- ext1.tag tag file for ext1 +- ext2 | +- html HTML output directory for ext2 | |- ext2.tag tag file for ext2 |- projectA.json DoxyPress project file for projectA |- ext1.json DoxyPress project file for ext1 |- ext2.json DoxyPress project file for ext2
The relevant parts of the project files will look as follows:
projectA.json
OUTPUT-DIR = projectA INPUT-SOURCE = projectA/src TAG-FILES = ext1/ext1.tag=../../ext1/html, ext2/ext2.tag=../../ext2/html
ext1.json
OUTPUT-DIR = ext1 GENERATE-TAGFILE = ext1/ext1.tag
ext2.json
OUTPUT-DIR = ext2 GENERATE-TAGFILE = ext2/ext2.tag