Question

I have #define values in headers that I certainly want Doxygen to document but I have others in C files that I treat as static constants and I don’t want Doxygen to document them. Something as simple and stupid as

#define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0]))
#define MSTR(e) #e

How can I keep Doxygen from putting those #defines in the documentation it creates? I’ve tried marking it with @internal but that didn’t seem to help.

A somewhat-related question on Doxygen and #define, how can I get:

#define SOME_CONSTANT 1234 /**< An explanation */

to put “SOME_CONSTANT” and “An explanation” but not “1234” in the output?

Answer 1

You can exclude any part of code from Doxygen parsing with \cond ... \endcond tags.

edit: Some related questions:

• How can Doxygen exclude a C++ class?
• Exclude some classes from doxygen documentation