Personal tools
You are here: Home → Documentation → How-tos → Generate up to date firmware documentation
In This Section
Log in


Forgot your password?
New user?
 
Document Actions

Generate up to date firmware documentation


This How-to is intended for: Microcontroller Developers

Sometimes, if you're working from the source code in SVN, the online documentation can be out of date - generate your own if you want.

Problem

Typically, documentation is only committed to the SVN repository when a release of the firmware is made.  If you're working with code from the SVN repository, the online documentation might not cover everything in there.  Or, you might want to generate documentation for your own code.


Solution

DoxygenGenerate the latest documentation using the open source tool Doxygen. This assumes you have already downloaded the Make Controller firmware source code, which exists in a directory called firmware.


This is pretty easy...there are just a few steps:

  1. Download the latest version of Doxygen from its download page at http://www.stack.nl/~dimitri/doxygen/download.html
  2. Open up Doxygen and load the Doxyfile in the firmware source download - located in 
    firmware/doc/Doxyfile
  3. Run Doxygen and enjoy your shiny new documentation, which you can find in 
    firmware/doc/html/index.html

Discussion

The Doxyfile in the SVN repository is generally based on the latest version of Doxygen.  If you seem to have any trouble, verify you're working with the latest version.

If you contribute any code of your own, Doxygen is an easy way to make nice looking, easy to navigate documentation.  It works by reading specially formatted comments within the code itself and then generating HTML.  Check out the Doxygen manual for details.