Documenting preprocessor defines in Doxygen
Posted
by Fire Lancer
on Stack Overflow
See other posts from Stack Overflow
or by Fire Lancer
Published on 2010-03-01T13:38:27Z
Indexed on
2010/04/30
21:27 UTC
Read the original article
Hit count: 261
Is it possible to document preprocessor defines in Doxygen? I expected to be able to do it just like a variable or function, however the Doxygen output appears to have "lost" the documentation for the define, and does not contain the define its self either.
I tried the following
/**My Preprocessor Macro.*/
#define TEST_DEFINE(x) (x*x)
and
/**@def TEST_DEFINE
My Preprocessor Macro.
*/
#define TEST_DEFINE(x) (x*x)
I also tried putting them within a group (tried defgroup, addtogroup and ingroup) rather than just at the "file scope" however that had no effect either (although other items in the group were documented as intended).
I looked through the various Doxygen options, but couldn't see anything that would enable (or prevent) the documentation of defines.
© Stack Overflow or respective owner