Generate a doxygen html

In the SHEMAT-Suite directory, you can generate documentation using doxygen by running

cd doc/
doxygen Doxyfile

Doxyfile is the input file that determines the documentation output. Running doxygen may take a few minutes. Final html output is saved to

/doc/sources/html/

and you can enter the documentation by opening the following html-file of the main page of the documentation in a browser (for example firefox):

/doc/sources/html/index.html

Call and caller graphs

Generating call and caller graphs for the subroutines of SHEMAT-Suite takes quite a long time, so it is not put as default at the moment. To turn them on, open Doxyfile and look for the lines

CALL_GRAPH             = NO
CALLER_GRAPH           = NO

and change the to NO to YES.

In the line

DOT_GRAPH_MAX_NODES    = 50

you can specify the size of the image. By setting this to 500, the full call graphs will be shown, for 50, some graphs are truncated.