Page History

Introduction 

The purpose of this page is to provide a uniform style of Doxygen commenting for the RDK system. It will serve as a reference for current and future developers, while documenting the RDK system as it evolves. Ultimately, this will establish a consistent manner of documentation to strengthen the simplicity, readability, scalability, writability, reliability, and maintainability of the system.

Documentation Style

Doxygen documentation can be generated in many formats(HTML, LaTeX, RTF, PDF, DOC) . HTML generation has support for more plugins and is easier to refactor as the system changes. Doxygen style should follow a consistent format to aid development across different IDEs. Additionally, it reduces issues when generating documentation.

...

/**
 * @mainpage                    Title of Document
 *                                           
 */

Example of HAL system Doxygen Guideline (Note: source code was also modified to support correct generation of documentation)

...

Setting up Doxygen Environment on Windows

Before generating Doxygen documentation, make sure to have the following:

Doxygen: http://www.stack.nl/~dimitri/doxygen/download.html (Contains Doxywizard )

Graphviz: http://www.graphviz.org/ (Click the Download link on the left side of the page)

• Navigate to the DoxyWizard (comes with Doxygen setup) application and configure it:

Image Added