Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.6 KB

DOCUMENTATION.md

File metadata and controls

34 lines (25 loc) · 1.6 KB

DLA Future Documentation

API documentation

How to generate the documentation

Note: Doxygen is required to generate the documentation.

The documentation can be built together with the project by enabling its generation with the flag DLAF_BUILD_DOC=on and then use the doc target to eventually generate it.

# from the build folder, if you have already configured the CMake project
cmake -DDLAF_BUILD_DOC=on .
make doc

Alternatively, the documentation can be generated independently by using doc/Doxyfile.in, which is a template configuration file in which you have to replace the text ${DLAF_SOURCE_DIR} with the root folder of DLAF containing the source code (e.g. where you cloned this repository).

As a shortcut for this process a doc/Makefile is available, which automatically performs the substitution and then generates the documentation.

cd doc
make doc