Help: Clean up formatting and typos in autogen docs

This commit is contained in:
Craig Scott
2020-01-09 20:32:27 +11:00
parent 2ec57e11fb
commit dd2f42cc84
4 changed files with 7 additions and 7 deletions

View File

@@ -4,9 +4,9 @@ AUTOGEN_PARALLEL
Number of parallel ``moc`` or ``uic`` processes to start when using
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
The custom `<origin>_autogen` target starts a number of threads of which
The custom ``<origin>_autogen`` target starts a number of threads of which
each one parses a source file and on demand starts a ``moc`` or ``uic``
process. :prop_tgt:`AUTOGEN_PARALLEL` controls how many parallel threads
process. ``AUTOGEN_PARALLEL`` controls how many parallel threads
(and therefore ``moc`` or ``uic`` processes) are started.
- An empty (or unset) value or the string ``AUTO`` sets the number of
@@ -14,7 +14,7 @@ process. :prop_tgt:`AUTOGEN_PARALLEL` controls how many parallel threads
- A positive non zero integer value sets the exact thread/process count.
- Otherwise a single thread/process is started.
By default :prop_tgt:`AUTOGEN_PARALLEL` is initialized from
By default ``AUTOGEN_PARALLEL`` is initialized from
:variable:`CMAKE_AUTOGEN_PARALLEL`.
See the :manual:`cmake-qt(7)` manual for more information on using CMake

View File

@@ -172,7 +172,7 @@ variables. If the call is in a different context than the
then the version variables might not be available to the :prop_tgt:`AUTOMOC`
enabled target.
In that case the version variables can be forwarded from the
`find_package(Qt[45]...)` calling context to the :command:`add_executable`
``find_package(Qt[45]...)`` calling context to the :command:`add_executable`
or :command:`add_library` calling context as directory properties.
The following Qt5 example demonstrates the procedure.

View File

@@ -1,7 +1,7 @@
AUTOMOC_MOC_OPTIONS
-------------------
Additional options for moc when using :prop_tgt:`AUTOMOC`
Additional options for ``moc`` when using :prop_tgt:`AUTOMOC`
This property is only used if the :prop_tgt:`AUTOMOC` property is ``ON``
for this target. In this case, it holds additional command line

View File

@@ -21,11 +21,11 @@ with Qt.
Reproducible builds
^^^^^^^^^^^^^^^^^^^
For reproducible builds is is recommended to keep headers that are ``moc``
For reproducible builds it is recommended to keep headers that are ``moc``
compiled in one of the target
:command:`include directories <target_include_directories>` and set
:prop_tgt:`AUTOMOC_PATH_PREFIX` to ``ON`` (which is the default). This ensures
that
that:
- ``moc`` output files are identical on different build setups,
- ``moc`` output files will compile correctly when the source and/or