Building Doxygen

As of PR #186, TPS has some doxygen-style comments and supports generating html code documentation based on these comments.

Dependencies

To build the html, you will need two external packages:

1. doxygen - https://www.doxygen.nl/
2. graphviz/dot - https://graphviz.org/

These packages are installed in the TPS test docker container.

Procedure

Given these packages, simply configure TPS as you normally would. While there are no configure switches associated with the doxygen documentation, the doxygen executable and path information for the generated html are determined by configure. Assuming you're starting from the TPS top-level, an out-of-source build would look as follows:

1. Configure as usual

$ mkdir build
$ ./bootstrap
$ cd build
$ ../configure CXXFLAGS="-g -O2 -Wall"

2. Build the doc target

$ cd src
$ make doc

3. Check out the documentation by pointing your browser to <tps-top-level>/build/doc/html/index.html