From 75ec6215b36a3dc75d20f130d22da994289320a6 Mon Sep 17 00:00:00 2001 From: "Friedrich W. H. Kossebau" Date: Thu, 23 Jan 2020 11:49:57 +0100 Subject: ECMAddQch: support & document K_DOXYGEN macro usage --- modules/ECMAddQch.cmake | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'modules/ECMAddQch.cmake') 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 -- cgit v1.2.1