How to Generate the Documentation

Clone the GIT Repo SLProject_doc

• Clone GIT Repo SLProject_doc into the SLProject folder
• Rename the folder into _doc

Download Doxygen and the Graphviz tool

• Doxygen is a tool that can generate an HTML documentation from the source code.
• You can download it for free at: https://doxygen.nl/
• Install Doxygen with default options.
• For the graphics inside the documentation Doxygen uses the Graphviz tool.
• You can download it for free at: http://www.graphviz.org/
• Install the Graphviz tool with the default options.
• On macOS you can install both tools with brew install graphviz

Generate the HTML-Documentation

• Open the Doxygen.exe (or .app on MacOS)
• Over the menu File > Open ... open the file Doxyfile in the folder _doc.
• Under the tab Wizard > Project adapt the Project version or id
• Under the tab Wizard > Project select the SLProject.png in the folder _doc as logo.
• Under the tab Expert > Dot set the correct path to the dot tool (Graphviz) in DOT_PATH.
• Under the tab Run press Run doxygen to launch the generation process.
• The documentation is generated into the folder _doc
• After generation open the index.html page inside the _doc folder.