Generate doxygen documentation for SciCell++

This allows you to create class diagrams and browseable documentation directly from the source code of SciCell++.

You need to install Doxygen and Latex to generate documentation from source code.

You may check this section for doxygen installation.

Workflow

  1. Open a command line and go to the main folder of the project.

  2. In the command line type the following:

    ./tools/user/make_doc.sh

    Voila! The documentation will be automatically generated into the ./doxy_doc/html folder.

  3. Open the file ./doxy_doc/html/index.html within your favorite web-browser to browse the documentation.