Currently kapidox uses the macro DOXYGEN_SHOULD_SKIP_THIS to enable code
it processes to control what doxygen sees. That macro, while taken from
the example given in the official doxygen documentation,
( http://www.doxygen.nl/manual/faq.html#faq_code ) has some disadvantages:
- it is not a macro officially set by doxygen
- its semantic can be confusing to human readers in case it needs to be used with #ifdef instead of the #ifndef as in the doxygen documentation example
Example:
#ifdef DOXYGEN_SHOULD_SKIP_THIS
// will this code be processed by kapidox/doxygen? Yes, it will
#endif
Using a K_DOXYGEN macro definition instead follows an existing pattern
known from code checking the (compiler) tool being processed by, like
GNUC, clang or Q_QDOC.