Autogen: Add documentation for AUTOMOC_MACRO_NAMES

2026-05-02 04:09:33 -05:00 · 2017-08-18 13:58:14 +02:00
parent 05891d8f77
commit 7529d84fac
6 changed files with 62 additions and 5 deletions
@@ -0,0 +1,19 @@
+CMAKE_AUTOMOC_MACRO_NAMES
+----------------------------
+
+Additional macro names used by :variable:`CMAKE_AUTOMOC`
+to determine if a C++ file needs to be processed by ``moc``.
+
+This variable is used to initialize the :prop_tgt:`AUTOMOC_MACRO_NAMES`
+property on all the targets. See that target property for additional
+information.
+
+By default it is empty.
+
+Example
+-------
+Let CMake know that source files that contain ``CUSTOM_MACRO`` must be ``moc``
+processed as well::
+
+  set(CMAKE_AUTOMOC ON)
+  set(CMAKE_AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")