Browse Source

Help: Adjust the QtAutogen properties to the common style.

Link to the cmake-qt manual.
Stephen Kelly 12 years ago
parent
commit
cc46b702d0

+ 4 - 1
Help/prop_tgt/AUTOGEN_TARGET_DEPENDS.rst

@@ -3,7 +3,7 @@ AUTOGEN_TARGET_DEPENDS
 
 Target dependencies of the corresponding ``_automoc`` target.
 
-Targets which have their :prop_tgt:`AUTOMOC` target set to ``TRUE`` have a
+Targets which have their :prop_tgt:`AUTOMOC` target ``ON`` have a
 corresponding ``_automoc`` target which is used to autogenerate generate moc
 files.  As this ``_automoc`` target is created at generate-time, it is not
 possible to define dependencies of it, such as to create inputs for the ``moc``
@@ -12,3 +12,6 @@ executable.
 The ``AUTOGEN_TARGET_DEPENDS`` target property can be set instead to a list of
 dependencies for the ``_automoc`` target.  The buildsystem will be generated to
 depend on its contents.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 8 - 5
Help/prop_tgt/AUTOMOC.rst

@@ -6,7 +6,7 @@ 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 to ``TRUE``, CMake will scan the
+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
@@ -20,15 +20,18 @@ for ``Q_OBJECT`` macros, and if found, ``moc`` is also executed on those files.
 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
-:variable:`CMAKE_AUTOMOC` if it is set when a target is created.
+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.
 
-By setting the :variable:`CMAKE_AUTOMOC_RELAXED_MODE` variable to ``TRUE`` the
+By enabling the :variable:`CMAKE_AUTOMOC_RELAXED_MODE` variable the
 rules for searching the files which will be processed by moc can be relaxed.
 See the documentation for this variable for more details.
 
-The global property :prop_gbl:`AUTOMOC_TARGETS_FOLDER` can be used to group the
+The global property :prop_gbl:`AUTOGEN_TARGETS_FOLDER` can be used to group the
 automoc targets together in an IDE, e.g.  in MSVS.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 8 - 5
Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst

@@ -3,10 +3,13 @@ AUTOMOC_MOC_OPTIONS
 
 Additional options for moc when using :prop_tgt:`AUTOMOC`
 
-This property is only used if the :prop_tgt:`AUTOMOC` property is set to ``TRUE``
-for this target.  In this case, it holds additional command line options
-which will be used when ``moc`` is executed during the build, i.e.  it is
-equivalent to the optional ``OPTIONS`` argument of the :module:`qt4_wrap_cpp() <FindQt4>`
-macro.
+This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON``
+for this target.  In this case, it holds additional command line
+options which will be used when ``moc`` is executed during the build, i.e.
+it is equivalent to the optional ``OPTIONS`` argument of the
+:module:`qt4_wrap_cpp() <FindQt4>` macro.
 
 By default it is empty.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 8 - 6
Help/prop_tgt/AUTORCC.rst

@@ -1,4 +1,3 @@
-
 AUTORCC
 -------
 
@@ -6,10 +5,10 @@ Should the target be processed with autorcc (for Qt projects).
 
 ``AUTORCC`` is a boolean specifying whether CMake will handle
 the Qt ``rcc`` code generator automatically, i.e. without having to use
-the :module:`QT4_ADD_RESOURCES() <FindQt4>` or QT5_ADD_RESOURCES() macro.
-Currently Qt4 and Qt5 are supported.
+the :module:`QT4_ADD_RESOURCES() <FindQt4>` or ``QT5_ADD_RESOURCES()``
+macro.  Currently Qt4 and Qt5 are supported.
 
-When this property is set to ``TRUE``, CMake will handle ``.qrc`` files added
+When this property is ``ON``, CMake will handle ``.qrc`` files added
 as target sources at build time and invoke ``rcc`` accordingly.
 This property is initialized by the value of the :variable:`CMAKE_AUTORCC`
 variable if it is set when a target is created.
@@ -17,5 +16,8 @@ variable if it is set when a target is created.
 Additional command line options for rcc can be set via the
 :prop_sf:`AUTORCC_OPTIONS` source file property on the ``.qrc`` file.
 
-The global property :prop_gbl:`AUTOGEN_TARGETS_FOLDER` can be used to group the
-autouic targets together in an IDE, e.g. in MSVS.
+The global property :prop_gbl:`AUTOGEN_TARGETS_FOLDER` can be used to group
+the autorcc targets together in an IDE, e.g. in MSVS.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 10 - 6
Help/prop_tgt/AUTORCC_OPTIONS.rst

@@ -3,15 +3,19 @@ AUTORCC_OPTIONS
 
 Additional options for ``rcc`` when using :prop_tgt:`AUTORCC`
 
-This property holds additional command line options
-which will be used when ``rcc`` is executed during the build via :prop_tgt:`AUTORCC`,
+This property holds additional command line options which will be used
+when ``rcc`` is executed during the build via :prop_tgt:`AUTORCC`,
 i.e. it is equivalent to the optional ``OPTIONS`` argument of the
 :module:`qt4_add_resources() <FindQt4>` macro.
 
 By default it is empty.
 
-This property is initialized by the value of the variable
-:variable:`CMAKE_AUTORCC` if it is set when a target is created.
+This property is initialized by the value of the
+:variable:`CMAKE_AUTORCC_OPTIONS` variable if it is set when a target is
+created.
 
-The options set on the target may be overridden by :prop_sf:`AUTORCC_OPTIONS` set
-on the ``.qrc`` source file.
+The options set on the target may be overridden by :prop_sf:`AUTORCC_OPTIONS`
+set on the ``.qrc`` source file.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 10 - 8
Help/prop_tgt/AUTOUIC.rst

@@ -5,18 +5,20 @@ Should the target be processed with autouic (for Qt projects).
 
 ``AUTOUIC`` is a boolean specifying whether CMake will handle
 the Qt ``uic`` code generator automatically, i.e. without having to use
-the :module:`QT4_WRAP_UI() <FindQt4>` or QT5_WRAP_UI() macro. Currently Qt4
-and Qt5 are supported.
+the :module:`QT4_WRAP_UI() <FindQt4>` or ``QT5_WRAP_UI()`` macro. Currently
+Qt4 and Qt5 are supported.
 
-When this property is set to ``TRUE``, CMake will scan the source files
-at build time and invoke ``uic`` accordingly.
-If an ``#include`` statement like ``#include "ui_foo.h"`` is found in
-``foo.cpp``, a ``foo.ui`` file is expected next to ``foo.cpp``, and ``uic`` is
-run on the ``foo.ui`` file.
+When this property is ``ON``, CMake will scan the source files at build time
+and invoke ``uic`` accordingly.  If an ``#include`` statement like
+``#include "ui_foo.h"`` is found in ``foo.cpp``, a ``foo.ui`` file is
+expected next to ``foo.cpp``, and ``uic`` is run on the ``foo.ui`` file.
 This property is initialized by the value of the :variable:`CMAKE_AUTOUIC`
 variable if it is set when a target is created.
 
-Additional command line options for uic can be set via the
+Additional command line options for ``uic`` can be set via the
 :prop_sf:`AUTOUIC_OPTIONS` source file property on the ``foo.ui`` file.
 The global property :prop_gbl:`AUTOGEN_TARGETS_FOLDER` can be used to group the
 autouic targets together in an IDE, e.g. in MSVS.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.

+ 11 - 7
Help/prop_tgt/AUTOUIC_OPTIONS.rst

@@ -3,19 +3,23 @@ AUTOUIC_OPTIONS
 
 Additional options for uic when using :prop_tgt:`AUTOUIC`
 
-This property holds additional command line options
-which will be used when ``uic`` is executed during the build via :prop_tgt:`AUTOUIC`,
-i.e. it is equivalent to the optional ``OPTIONS`` argument of the
+This property holds additional command line options which will be used when
+``uic`` is executed during the build via :prop_tgt:`AUTOUIC`, i.e. it is
+equivalent to the optional ``OPTIONS`` argument of the
 :module:`qt4_wrap_ui() <FindQt4>` macro.
 
 By default it is empty.
 
-This property is initialized by the value of the variable
-:variable:`CMAKE_AUTOUIC` if it is set when a target is created.
+This property is initialized by the value of the
+:variable:`CMAKE_AUTOUIC_OPTIONS` variable if it is set when a target is
+created.
 
-The options set on the target may be overridden by :prop_sf:`AUTOUIC_OPTIONS` set
-on the ``.ui`` source file.
+The options set on the target may be overridden by :prop_sf:`AUTOUIC_OPTIONS`
+set on the ``.ui`` source file.
 
 This property may use "generator expressions" with the syntax ``$<...>``.
 See the :manual:`cmake-generator-expressions(7)` manual for available
 expressions.
+
+See the :manual:`cmake-qt(7)` manual for more information on using CMake
+with Qt.