Skip to end of metadata
Go to start of metadata

Overview

This page illustrates the use of common doxygen tags in code and its corresponding generation. Please reference to this list for more options.
As of 2102, buildbot generates doxygen here.

Module Documentation

Below is a snapshot of tags used:

Here is the corresponding doxygen look:

Class Documentation

Below is a snapshot. Doxypy in this case reads the python doc string.

Here is the corresponding doxygen look:

Method Documentation

Below is a snapshot of tags used:

Here is the corresponding doxygen look:

Test Documentation

Below is a snapshot of tags used:

Here is the corresponding doxygen look:

Below is an extra test list page generated by doxygen as a result:

References, notes, todos

Below is a snapshot of tags used:

Here is the corresponding doxygen look:

Here is the todo list page generated:

Bug Documentation

Below is a snapshot of tags used:

Here is the corresponding doxygen look:

Here is the bug list page generated:

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.