Example documentation with doxygen

Collaboration diagram for Example documentation with doxygen:

Modules
	Example subgroup documentation

Files
file	example_doc.cc
	Illustrates how to group documentation between files.

Classes
class	ExampleClass1
	Every class should be documented (this is the brief line) More...
class	ExampleClass2
	Brief documentation of second example class in group. More...

Functions
int	example_func (int a)
	Global function in example group. More...

Detailed Description

This module illustrates how to document your files with doxygen. Please use a regular editor to view example_doc.h and example_doc.cc in order to understand how this documentation was generated.

Every file needs \file and \brief near the top, and usually a \defgroup or \ingroup. If you have put the file in a group then the file-level documentation acts as documentation for that module or group, otherwise it acts as documentation for the file. Note that doxygen is really picky about placement and association of comments so you always have to check what was generated.

Links to known classes (such as ExampleClass1), functions (such as example_func()), and files (such as example_doc.h) are made automatically.

Subsection title

Use the \par directive to make subsections with an optional heading. Doxygen's section and subsection directives should not be used for now.

Function Documentation

int example_func

(

int

a

)

Global function in example group.

Parameters

[in]

a

The input argument is ...

Returns

The return value is ...