diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -50,8 +50,14 @@ Writing dox is beyond the scope of this documentation -- see the notes at and the [doxygen manual](http://doxygen.nl/manual/docblocks.html). -However, the script expects certain things to be present in the directory it is -run on. + +To allow code to handle the case of being processed by kapidox a C/C++ preprocessor macro +is set as defined when run: `K_DOXYGEN` (since v5.67.0). +For backward-compatibility the definition `DOXYGEN_SHOULD_SKIP_THIS` is also set, but +its usage is deprecated. + +The kapidox scripts expects certain things to be present in the directory it is +run on: ### README.md Most importantly, there should be a `README.md` file, like this page (backward diff --git a/src/kapidox/data/Doxyfile.global b/src/kapidox/data/Doxyfile.global --- a/src/kapidox/data/Doxyfile.global +++ b/src/kapidox/data/Doxyfile.global @@ -167,7 +167,10 @@ MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES +# K_DOXYGEN set to have preprocessor macros know that kapidox/doxygen processes them +# DOXYGEN_SHOULD_SKIP_THIS is the deprecated variant (remove for KF6) PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ + K_DOXYGEN \ Q_SLOTS="slots" \ Q_SIGNALS="signals" \ Q_DECL_CONSTEXPR="constexpr" \