diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2020-01-23 11:49:57 +0100 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2020-01-23 11:49:57 +0100 |
| commit | 75ec6215b36a3dc75d20f130d22da994289320a6 (patch) | |
| tree | b9ece09cb58e2a1bb0bfdc131ebeb2154e1a6a6c /modules | |
| parent | 9b62540496ec6847b4839087d532a2b980a5a968 (diff) | |
| download | extra-cmake-modules-75ec6215b36a3dc75d20f130d22da994289320a6.tar.gz extra-cmake-modules-75ec6215b36a3dc75d20f130d22da994289320a6.tar.bz2 | |
ECMAddQch: support & document K_DOXYGEN macro usage
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/ECMAddQch.cmake | 6 | ||||
| -rw-r--r-- | modules/ECMQchDoxygen.config.in | 3 |
2 files changed, 9 insertions, 0 deletions
diff --git a/modules/ECMAddQch.cmake b/modules/ECMAddQch.cmake index cae829f1..bd72a9c8 100644 --- a/modules/ECMAddQch.cmake +++ b/modules/ECMAddQch.cmake @@ -145,6 +145,12 @@ # VERBOSE tells the API dox generation tool to be more verbose about its # activity. # +# The default config file for the API dox generation tool, so the one when not +# using CONFIG_TEMPLATE, allows code to handle the case of being processed by +# the tool by defining the C/C++ preprocessor macro ``K_DOXYGEN`` when run +# (since v5.67.0). For backward-compatibility also the definition +# ``DOXYGEN_SHOULD_SKIP_THIS`` is set, but its usage is deprecated. +# # Example usage: # # .. code-block:: cmake diff --git a/modules/ECMQchDoxygen.config.in b/modules/ECMQchDoxygen.config.in index 7964a547..88d51606 100644 --- a/modules/ECMQchDoxygen.config.in +++ b/modules/ECMQchDoxygen.config.in @@ -204,7 +204,10 @@ ALIASES = "intern=\par<b>Internal use only.</b>" \ "mit=<a href=\"https://www.opensource.org/licenses/mit-license.php\">MIT</a>" \ "qpl=<a href=\"https://opensource.org/licenses/QPL-1.0\">QPL</a>" +# 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_WS_X11= \ Q_WS_WIN= \ |