Using Doxygen

Table of Contents

• Building documentation
• Writing Documentation
  • In Source Documentation
  • Documentation Pages
  • Example Programs
• Doxygen Commands

The Open FUSION Toolkit uses Doxygen to create structured and navigable documentation from the source code and structured comments. When adding new components or modifying exisiting elements the associated documentation should be updated to allow easy reference. For information on Doxygen specific commands which can be used to supplement documentation see the Doxygen documentation.

Building documentation

Documentation can be built from the src/docs directory by running the following command, where /path/to/doxygen is the location of the doxygen executable on your computer. This will create a folder src/../doc/html which contains the updated documentation.

~$ /path/to/doxygen doxy_oft.conf

Writing Documentation

Docs needed

In Source Documentation

Docs needed

Documentation Pages

Docs needed

Example Programs

Docs needed

Doxygen Commands

Docs needed