Help: Reformat Qt autogenerator documentation.
This commit is contained in:
Stephen Kelly
parent
d98ea6c0b8
commit
43340a9c96
|
|
@ -1,8 +1,9 @@
|
|||
AUTOGEN_TARGETS_FOLDER
|
||||
----------------------
|
||||
|
||||
Name of FOLDER for ``*_automoc`` targets that are added automatically by CMake for targets for which AUTOMOC is enabled.
|
||||
Name of :prop_tgt:`FOLDER` for ``*_automoc`` targets that are added automatically by
|
||||
CMake for targets for which :prop_tgt:`AUTOMOC` is enabled.
|
||||
|
||||
If not set, CMake uses the FOLDER property of the parent target as a
|
||||
If not set, CMake uses the :prop_tgt:`FOLDER` property of the parent target as a
|
||||
default value for this property. See also the documentation for the
|
||||
FOLDER target property and the AUTOMOC target property.
|
||||
:prop_tgt:`FOLDER` target property and the :prop_tgt:`AUTOMOC` target property.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
AUTOMOC_TARGETS_FOLDER
|
||||
----------------------
|
||||
|
||||
Name of FOLDER for ``*_automoc`` targets that are added automatically by CMake for targets for which AUTOMOC is enabled.
|
||||
Name of :prop_tgt:`FOLDER` for ``*_automoc`` targets that are added automatically by
|
||||
CMake for targets for which :prop_tgt:`AUTOMOC` is enabled.
|
||||
|
||||
This property is obsolete. Use AUTOGEN_TARGETS_FOLDER instead.
|
||||
This property is obsolete. Use :prop_gbl:`AUTOGEN_TARGETS_FOLDER` instead.
|
||||
|
||||
If not set, CMake uses the FOLDER property of the parent target as a
|
||||
If not set, CMake uses the :prop_tgt:`FOLDER` property of the parent target as a
|
||||
default value for this property. See also the documentation for the
|
||||
FOLDER target property and the AUTOMOC target property.
|
||||
:prop_tgt:`FOLDER` target property and the :prop_tgt:`AUTOMOC` target property.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,13 @@
|
|||
AUTORCC_OPTIONS
|
||||
---------------
|
||||
|
||||
Additional options for rcc when using autorcc (see the :prop_tgt:`AUTORCC` target
|
||||
property)
|
||||
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 autorcc, i.e. it is equivalent to the
|
||||
optional OPTIONS argument of the qt4_add_resources() macro.
|
||||
``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.
|
||||
|
||||
The options set on the .qrc source file may override :prop_tgt:`AUTORCC_OPTIONS` set
|
||||
The options set on the ``.qrc`` source file may override :prop_tgt:`AUTORCC_OPTIONS` set
|
||||
on the target.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
AUTOUIC_OPTIONS
|
||||
---------------
|
||||
|
||||
Additional options for uic when using autouic (see the :prop_tgt:`AUTOUIC` target property)
|
||||
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 autouic,
|
||||
i.e. it is equivalent to the optional OPTIONS argument of the
|
||||
qt4_wrap_ui() macro.
|
||||
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.
|
||||
|
||||
The options set on the .ui source file may override :prop_tgt:`AUTOUIC_OPTIONS` set
|
||||
The options set on the ``.ui`` source file may override :prop_tgt:`AUTOUIC_OPTIONS` set
|
||||
on the target.
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@ 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 set to ``TRUE`` 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
|
||||
possible to define dependencies of it, such as to create inputs for the ``moc``
|
||||
executable.
|
||||
|
||||
The ``AUTOGEN_TARGET_DEPENDS`` target can be set instead to a list of dependencies
|
||||
|
|
|
|||
|
|
@ -3,29 +3,29 @@ AUTOMOC
|
|||
|
||||
Should the target be processed with automoc (for Qt projects).
|
||||
|
||||
AUTOMOC is a boolean specifying whether CMake will handle the Qt moc
|
||||
AUTOMOC is a boolean specifying whether CMake will handle the Qt ``moc``
|
||||
preprocessor automatically, i.e. without having to use the
|
||||
QT4_WRAP_CPP() or QT5_WRAP_CPP() 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 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
|
||||
: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
|
||||
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, all header files are parsed for
|
||||
Q_OBJECT macros, and if found, moc is also executed on those files.
|
||||
``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
|
||||
CMAKE_AUTOMOC if it is set when a target is created.
|
||||
``<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.
|
||||
|
||||
Additional command line options for moc can be set via the
|
||||
AUTOMOC_MOC_OPTIONS property.
|
||||
:prop_tgt:`AUTOMOC_MOC_OPTIONS` property.
|
||||
|
||||
By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules
|
||||
for searching the files which will be processed by moc can be relaxed.
|
||||
By setting the :variable:`CMAKE_AUTOMOC_RELAXED_MODE` variable to ``TRUE`` 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 AUTOMOC_TARGETS_FOLDER can be used to group the
|
||||
The global property :prop_gbl:`AUTOMOC_TARGETS_FOLDER` can be used to group the
|
||||
automoc targets together in an IDE, e.g. in MSVS.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
AUTOMOC_MOC_OPTIONS
|
||||
-------------------
|
||||
|
||||
Additional options for moc when using automoc (see the AUTOMOC property)
|
||||
Additional options for moc when using :prop_tgt:`AUTOMOC`
|
||||
|
||||
This property is only used if the 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 qt4_wrap_cpp()
|
||||
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.
|
||||
|
||||
By default it is empty.
|
||||
|
|
|
|||
|
|
@ -4,18 +4,18 @@ AUTORCC
|
|||
|
||||
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 QT4_ADD_RESOURCES() or QT5_ADD_RESOURCES() macro. Currently Qt4 and Qt5 are
|
||||
supported.
|
||||
``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.
|
||||
|
||||
When this property is set to TRUE, CMake will handle .qrc files added
|
||||
as target sources at build time and invoke rcc accordingly.
|
||||
When this property is set to ``TRUE``, 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.
|
||||
|
||||
Additional command line options for rcc can be set via the
|
||||
:prop_sf:`AUTORCC_OPTIONS` source file property on the .qrc file.
|
||||
: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.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
AUTORCC_OPTIONS
|
||||
---------------
|
||||
|
||||
Additional options for rcc when using autorcc (see the :prop_tgt:`AUTORCC` target property)
|
||||
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 autorcc,
|
||||
i.e. it is equivalent to the optional OPTIONS argument of the
|
||||
qt4_add_resources() macro.
|
||||
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.
|
||||
|
||||
|
|
@ -14,4 +14,4 @@ This property is initialized by the value of the variable
|
|||
:variable:`CMAKE_AUTORCC` 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.
|
||||
on the ``.qrc`` source file.
|
||||
|
|
|
|||
|
|
@ -3,20 +3,20 @@ AUTOUIC
|
|||
|
||||
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 QT4_WRAP_UI() or QT5_WRAP_UI() macro. Currently Qt4 and Qt5 are
|
||||
supported.
|
||||
``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.
|
||||
|
||||
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 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.
|
||||
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
|
||||
:prop_sf:`AUTOUIC_OPTIONS` source file property on the foo.ui file.
|
||||
: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.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
AUTOUIC_OPTIONS
|
||||
---------------
|
||||
|
||||
Additional options for uic when using autouic (see the :prop_tgt:`AUTOUIC` target property)
|
||||
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 autouic,
|
||||
i.e. it is equivalent to the optional OPTIONS argument of the
|
||||
qt4_wrap_ui() macro.
|
||||
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.
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ This property is initialized by the value of the variable
|
|||
:variable:`CMAKE_AUTOUIC` 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.
|
||||
on the ``.ui`` source file.
|
||||
|
||||
This property may use "generator expressions" with the syntax "$<...>".
|
||||
See the :manual:`cmake-generator-expressions(7)` manual for available
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
CMAKE_AUTOMOC
|
||||
-------------
|
||||
|
||||
Whether to handle moc automatically for Qt targets.
|
||||
Whether to handle ``moc`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the AUTOMOC property on all the
|
||||
This variable is used to initialize the :prop_tgt:`AUTOMOC` property on all the
|
||||
targets. See that target property for additional information.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
CMAKE_AUTOMOC_MOC_OPTIONS
|
||||
-------------------------
|
||||
|
||||
Additional options for moc when using automoc (see CMAKE_AUTOMOC).
|
||||
Additional options for ``moc`` when using :variable:`CMAKE_AUTOMOC`.
|
||||
|
||||
This variable is used to initialize the AUTOMOC_MOC_OPTIONS property
|
||||
on all the targets. See that target property for additional
|
||||
information.
|
||||
This variable is used to initialize the :prop_tgt:`AUTOMOC_MOC_OPTIONS` property
|
||||
on all the targets. See that target property for additional information.
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@ CMAKE_AUTOMOC_RELAXED_MODE
|
|||
|
||||
Switch between strict and relaxed automoc mode.
|
||||
|
||||
By default, automoc behaves exactly as described in the documentation
|
||||
of the AUTOMOC target property. When set to TRUE, it accepts more
|
||||
input and tries to find the correct input file for moc even if it
|
||||
By default, :prop_tgt:`AUTOMOC` behaves exactly as described in the documentation
|
||||
of the :prop_tgt:`AUTOMOC` target property. When set to ``TRUE``, it accepts more
|
||||
input and tries to find the correct input file for ``moc`` even if it
|
||||
differs from the documented behaviour. In this mode it e.g. also
|
||||
checks whether a header file is intended to be processed by moc when a
|
||||
"foo.moc" file has been included.
|
||||
``"foo.moc"`` file has been included.
|
||||
|
||||
Relaxed mode has to be enabled for KDE4 compatibility.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
CMAKE_AUTORCC
|
||||
-------------
|
||||
|
||||
Whether to handle rcc automatically for Qt targets.
|
||||
Whether to handle ``rcc`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTORCC` property on all the targets.
|
||||
See that target property for additional information.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
CMAKE_AUTORCC_OPTIONS
|
||||
---------------------
|
||||
|
||||
Whether to handle rcc automatically for Qt targets.
|
||||
Whether to handle ``rcc`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTORCC_OPTIONS` property on
|
||||
all the targets. See that target property for additional information.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
CMAKE_AUTOUIC
|
||||
-------------
|
||||
|
||||
Whether to handle uic automatically for Qt targets.
|
||||
Whether to handle ``uic`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTOUIC` property on all the targets.
|
||||
See that target property for additional information.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
CMAKE_AUTOUIC_OPTIONS
|
||||
---------------------
|
||||
|
||||
Whether to handle uic automatically for Qt targets.
|
||||
Whether to handle ``uic`` automatically for Qt targets.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTOUIC_OPTIONS` property on
|
||||
all the targets. See that target property for additional information.
|
||||
|
|
|
|||
Loading…
Reference in New Issue