summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
diff options
context:
space:
mode:
authorSebastian Holtermann <sebholt@xwmw.org>2017-09-25 17:52:11 (GMT)
committerSebastian Holtermann <sebholt@xwmw.org>2017-09-28 07:21:44 (GMT)
commit08041dd15e7a4a030b2458e70018b50e1bbc0939 (patch)
tree89388697991b94120652300ac5ec648ea869506c /Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
parent7b33d67bc53446e89eb27d750d80e4b639f8d3e5 (diff)
downloadCMake-08041dd15e7a4a030b2458e70018b50e1bbc0939.zip
CMake-08041dd15e7a4a030b2458e70018b50e1bbc0939.tar.gz
CMake-08041dd15e7a4a030b2458e70018b50e1bbc0939.tar.bz2
Autogen: Doc: Update documentation for (CMAKE_)AUTOMOC_MACRO_NAMES
Diffstat (limited to 'Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst')
-rw-r--r--Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst21
1 files changed, 12 insertions, 9 deletions
diff --git a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
index 0639bc8..0535fde 100644
--- a/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
+++ b/Help/prop_tgt/AUTOMOC_MACRO_NAMES.rst
@@ -1,20 +1,23 @@
AUTOMOC_MACRO_NAMES
-------------------
-Additional macro names used by :prop_tgt:`AUTOMOC`
-to determine if a C++ file needs to be processed by ``moc``.
+A :ref:`;-list <CMake Language Lists>` list of macro names used by
+:prop_tgt:`AUTOMOC` to determine if a C++ file needs to be processed by ``moc``.
This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON``
for this target.
-CMake searches for the strings ``Q_OBJECT`` and ``Q_GADGET`` to
-determine if a file needs to be processed by ``moc``.
-:prop_tgt:`AUTOMOC_MACRO_NAMES` allows to add additional strings to the
-search list. This is useful for cases where the ``Q_OBJECT`` or ``Q_GADGET``
-macro is hidden inside another macro.
+When running :prop_tgt:`AUTOMOC`, CMake searches for the strings listed in
+:prop_tgt:`AUTOMOC_MACRO_NAMES` in C++ source and header files.
+If any of the strings is found
+
+- as the first non space string on a new line or
+- as the first non space string after a ``{`` on a new line,
+
+then the file will be processed by ``moc``.
By default :prop_tgt:`AUTOMOC_MACRO_NAMES` is initialized from
-:variable:`CMAKE_AUTOMOC_MACRO_NAMES`, which is empty by default.
+:variable:`CMAKE_AUTOMOC_MACRO_NAMES`.
See the :manual:`cmake-qt(7)` manual for more information on using CMake
with Qt.
@@ -25,4 +28,4 @@ In this case the the ``Q_OBJECT`` macro is hidden inside an other macro
called ``CUSTOM_MACRO``. To let CMake know that source files, that contain
``CUSTOM_MACRO``, need to be ``moc`` processed, we call::
- set_property(TARGET tgt PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")
+ set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")