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: http://www.stack.nl/~dimitri/doxygen/
• 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 default option.
• On MacOS you can install both tools with brew.

Generate the HTML-Documentation

• Under Windows: Double-click the batch file _doc/GenerateHTMLDoc.bat.
• It goes to the folder lib-SLProject and calls the dogygen.exe tool.
• The documentation is generated into the folder _doc.
• After generation it opens the default browser with the index.html page.
• Under Linux or OSX: Open a terminal an navigate to the folder _doc
• call the doxygen tool.
• The documentation is generated into the folder _doc
• After generation open the index.html page inside the _doc folder.