| Creating OpenZWave Documentation

Introduction

OpenZWave is still under development, and new features, bug fixes and interface changes are being made on a frequent basis. So it's premature to focus too much energy on producing user documentation at this point. However, several users have asked whether there is documentation available.

So here is a guide to producing your own version of the documentation (such as it is).

Doxygen-style comments

Much of the source code for the OpenZWave library and the OpenZWaveDotNet wrapper has been documented via comments in the .h header files associated with these projects. So, if you're working with OpenZWave in a development environment (which most users will be, since only source code is available at this point), you can find many functions documented in these files.

The format of the comments is designed to allow an external program, called Doxygen, to produce documentation (for example, a series of .html files) by scanning the project files, interpreting these comments and producing the .html code to organize and display the documentation in a sensible manner. So, to produce the most up-to-date copy of the documentation, a user can run Doxygen on the project folder in question (OpenZWave or OpenZWaveDotNet).

Getting and Using Doxygen

The Doxygen program can be downloaded from http://www.doxygen.org. Versions of Doxygen are available for Windows, linux and Mac operating systems (as well as source code).

Once Doxygen has been downloaded and installed you can produce documentation by running Doxywizard.exe. If you're new to Doxygen, here are some step-by-step instructions for creating OpenZWave documentation.

Other Documentation Sources

In addition to the documentation that can be generated with Doxygen, there are a variety of other sources of information on OpenZWave and on the ZWave protocol more generally. Some of these are linked here.