TerrainDocumenting

Chair for Computer Aided Medical Procedures & Augmented Reality
Lehrstuhl für Informatikanwendungen in der Medizin & Augmented Reality

Generate the Documentation for the Terrain3D

We use Doxygen to generate the documentation for theTerrain3D.

This is tested under Ubuntu Linux.

Install Doxygen

There are binary releases for all major platforms at http://www.stack.nl/~dimitri/doxygen/download.html.

You can use doxygen out of the box (e.g. doxygen-1.7.6.1.linux.bin.tar.gz) under Ubuntu by executing ./doxygen in the extracted lib folder.

Configure Doxygen

Use doxygen -g within the project root to generate an example configuration file.

Or you can use the one used for this tutorial (see: Attachments).

Generate the Docs

Run doxygen doc/Doxygen from the project root.

Create PDF

To create a nice .pdf file instead of a html output, you can install MikTex and run the make file generated by doxygen.

Graphics

You need graphviz to draw nice graphs and (UML) diagrams.

To use it with Ubuntu you can download the binaries here: http://www.graphviz.org/Download_linux_ubuntu.php. First extract the graphviz binary (e.g. graphviz_2.28.0-1_amd64.deb) using dpkg-deb -x graphviz_2.28.0-1_amd64.deb and add the containing usr/bin/dot to your PATH. Second extract the gaphviz library (e.g. * libgraphviz4_2.28.0-1_amd64.deb*) using dpkg-deb -x libgraphviz4_2.28.0-1_amd64.deb and add the containing usr/lib/libgvc.so.6 to your LD_LIBRARY_PATH. Now you can enable the Graphics feature in the configuration file (see: Configure Doxygen).

Documenting the code

Tips

Attachments

  • Doxyfile: Doxygen configuration file used for the tutorial.


Edit | Attach | Refresh | Diffs | More | Revision r1.6 - 05 Mar 2012 - 13:56 - MaxWeber

Lehrstuhl für Computer Aided Medical Procedures & Augmented Reality    rss.gif