How to write doxygen documentation for macro.

There are two typical types of macro definitions.

• One is to define constant macros. For this type of macro, we recommend putting documentation after members. See DOXYGEN_EXAMPLE_CONST_A and DOXYGEN_EXAMPLE_CONST_B in documentation/0.doxygen/example/include/macro.h for code exmaple.
• The other is to define macros with parameters. For this type of macro, we recommend using a method similar to documenting for functions, that is, writing comment block before the macro definition. More details please see How to write doxygen documentation for function. See DOXYGEN_EXAMPLE_ABS in documentation/0.doxygen/example/include/macro.h for code example.

We often categorize macros in our code. Similarly, when writing doxygen comments for these categorized macros, we can also group them. See DOXYGEN_EXAMPLE_GROUP_A_X/DOXYGEN_EXAMPLE_GROUP_A_Y and DOXYGEN_EXAMPLE_GROUP_B_X/DOXYGEN_EXAMPLE_GROUP_B_Y in documentation/0.doxygen/example/include/macro.h for code example.

See Doxygen Example of Macro for html output.