example/ExampleDoxygen.h

↰ Parent directory: example/

All headers to be included by Doxygen must have a @file statement like this.

Source: example/ExampleDoxygen.h

Namespaces

• example: Namespaces can be documented like any other entity. In fact, namespace must be documented in order for variables and functions to appear in Doxygen’s output. Only a single instance of the namespace should be documented.

Classes

• example::OpaqueStruct: Opaque C structs (such as carb::tasking::Counter) will not be processed by Doxygen as forward declarations. Use the @struct command to explicitly document the opaque struct.

• example::ExampleDoxygen: This is a class. The text up to the first empty line is considered the “brief” comment. It can span multiple sentences and lines, much like this comment.