summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-04-15 18:04:28 (GMT)
committerBrad King <brad.king@kitware.com>2016-04-22 12:46:10 (GMT)
commitd350308af6704e70f94ef00d45c4b52ad779e566 (patch)
tree680674ec2f17cbd02bf0682e23248ef047231a72 /Help
parent840b830bc6a76afe207bc08ca164eaabb731acaf (diff)
downloadCMake-d350308af6704e70f94ef00d45c4b52ad779e566.zip
CMake-d350308af6704e70f94ef00d45c4b52ad779e566.tar.gz
CMake-d350308af6704e70f94ef00d45c4b52ad779e566.tar.bz2
Help: Improve AUTOMOC documentation layout
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_tgt/AUTOMOC.rst39
1 files changed, 23 insertions, 16 deletions
diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst
index 045ebb2..bd1ace8 100644
--- a/Help/prop_tgt/AUTOMOC.rst
+++ b/Help/prop_tgt/AUTOMOC.rst
@@ -6,22 +6,29 @@ Should the target be processed with automoc (for Qt projects).
AUTOMOC is a boolean specifying whether CMake will handle the Qt ``moc``
preprocessor automatically, i.e. without having to use the
:module:`QT4_WRAP_CPP() <FindQt4>` or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are
-supported. When this property is set ``ON``, CMake will scan the
-source files at build time and invoke moc accordingly. If an ``#include``
-statement like ``#include "moc_foo.cpp"`` is found, the ``Q_OBJECT`` class
-declaration is expected in the header, and ``moc`` is run on the header
-file. If an ``#include`` statement like ``#include "foo.moc"`` is found, then
-a ``Q_OBJECT`` is expected in the current source file and ``moc`` is run on
-the file itself. Additionally, header files with the same base name (like
-``foo.h``) or ``_p`` appended to the base name (like ``foo_p.h``) are parsed
-for ``Q_OBJECT`` macros, and if found, ``moc`` is also executed on those files.
-``AUTOMOC`` checks multiple header alternative extensions, such as
-``hpp``, ``hxx`` etc when searching for headers.
-The resulting moc files, which are not included as shown above in any
-of the source files are included in a generated
-``<targetname>_automoc.cpp`` file, which is compiled as part of the
-target. This property is initialized by the value of the
-:variable:`CMAKE_AUTOMOC` variable if it is set when a target is created.
+supported.
+
+When this property is set ``ON``, CMake will scan the
+source files at build time and invoke moc accordingly.
+
+* If an ``#include`` statement like ``#include "moc_foo.cpp"`` is found,
+ the ``Q_OBJECT`` class declaration is expected in the header, and
+ ``moc`` is run on the header file.
+
+* If an ``#include`` statement like ``#include "foo.moc"`` is found,
+ then a ``Q_OBJECT`` is expected in the current source file and ``moc``
+ is run on the file itself. Additionally, header files with the same
+ base name (like ``foo.h``) or ``_p`` appended to the base name (like
+ ``foo_p.h``) are parsed for ``Q_OBJECT`` macros, and if found, ``moc``
+ is also executed on those files. ``AUTOMOC`` checks multiple header
+ alternative extensions, such as ``hpp``, ``hxx`` etc when searching
+ for headers. The resulting moc files, which are not included as shown
+ above in any of the source files are included in a generated
+ ``<targetname>_automoc.cpp`` file, which is compiled as part of the
+ target.
+
+This property is initialized by the value of the :variable:`CMAKE_AUTOMOC`
+variable if it is set when a target is created.
Additional command line options for moc can be set via the
:prop_tgt:`AUTOMOC_MOC_OPTIONS` property.