| Doxygen Step-by-Step

Introduction

To produce simple doxygen documentation for the OpenZWave libary, follow the steps below. Once you've successfully produced the base documentation, you may want to use doxygen's Expert mode to customize the output.

Using Doxygen to generate OpenZWave documentation: Step 1

Once Doxygen has been downloaded and installed, run Doxywizard.exe. Here is a screen shot of the first step of the Wizard completed.

- Make sure the source code directory points to the OpenZWave cpp/src directory on your system.
- Select the destination directory of your choice.

Using Doxygen to generate OpenZWave documentation: Step 2

The Mode selections allow you to control how much information is generated and to customize the output for a variety of programming languages.

You can reduce the amount of documentation generated by selecting "Documented entities only" and de-selecting the "Include cross-referenced..." check box. If you are using Doxygen to produce documentation for OpenZWaveDotNet, you might prefer "Optimize for C++/CLI output."

Using Doxygen to generate OpenZWave documentation: Step 3

The Output step determines what form the generated documentation should take. I generally prefer HTML with a navigation tree, searchable, but others are available.

Using Doxygen to generate OpenZWave documentation: Step 4

The Diagrams step determines whether Doxygen will produce class diagrams.

Using Doxygen to generate OpenZWave documentation: Step 5

That's it! Select the Run tab, then Run doxygen to produce the documentation files.

That's it! You should now have a version of OpenZWave documentation in your destination directory. Navigate into the .../html directory and load index.htm to display the top level of the documentation.