aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMAddQch.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'modules/ECMAddQch.cmake')
-rw-r--r--modules/ECMAddQch.cmake6
1 files changed, 6 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