qt_wrap_*: Add deprecation notes to command docs

Co-authored-by: Craig Scott <craig.scott@crascit.com>
This commit is contained in:
Tobias Hunger 2018-12-13 16:21:43 +01:00 committed by Craig Scott
parent 50454c96d6
commit 74dc68b406
3 changed files with 32 additions and 7 deletions

View File

@ -1,7 +1,16 @@
qt_wrap_cpp
-----------
Create Qt Wrappers.
.. deprecated:: 3.14
This command was originally added to support Qt 3 before the
:command:`add_custom_command()` command was sufficiently mature. The
:module:`FindQt4` module provides the ``qt4_wrap_cpp()`` macro, which
should be used instead for Qt 4 projects. For projects using Qt 5 or
later, use the equivalent macro provided by Qt itself (e.g. Qt 5 provides
``qt5_wrap_cpp()``).
Manually create Qt Wrappers.
.. code-block:: cmake
@ -9,3 +18,6 @@ Create Qt Wrappers.
Produces moc files for all the .h files listed in the SourceLists. The
moc files will be added to the library using the ``DestName`` source list.
Consider updating the project to use the :prop_tgt:`AUTOMOC` target property
instead for a more automated way of invoking the ``moc`` tool.

View File

@ -1,7 +1,16 @@
qt_wrap_ui
----------
Create Qt user interfaces Wrappers.
.. deprecated:: 3.14
This command was originally added to support Qt 3 before the
:command:`add_custom_command()` command was sufficiently mature. The
:module:`FindQt4` module provides the ``qt4_wrap_ui()`` macro, which
should be used instead for Qt 4 projects. For projects using Qt 5 or
later, use the equivalent macro provided by Qt itself (e.g. Qt 5 provides
``qt5_wrap_ui()``).
Manually create Qt user interfaces Wrappers.
.. code-block:: cmake
@ -12,3 +21,6 @@ Produces .h and .cxx files for all the .ui files listed in the
``SourceLists``. The .h files will be added to the library using the
``HeadersDestNamesource`` list. The .cxx files will be added to the
library using the ``SourcesDestNamesource`` list.
Consider updating the project to use the :prop_tgt:`AUTOUIC` target property
instead for a more automated way of invoking the ``uic`` tool.

View File

@ -100,8 +100,6 @@ These commands are available only in CMake projects.
/command/link_libraries
/command/load_cache
/command/project
/command/qt_wrap_cpp
/command/qt_wrap_ui
/command/remove_definitions
/command/set_source_files_properties
/command/set_target_properties
@ -145,9 +143,10 @@ These commands are available only in CTest scripts.
Deprecated Commands
===================
These commands are deprecated since CMake version 3.0.
They are available only for backward compatibility.
Do not use them in new code.
These commands are deprecated and are only made available to maintain
backward compatibility. The documentation of each command states the
CMake version in which it was deprecated. Do not use these commands
in new code.
.. toctree::
:maxdepth: 1
@ -161,6 +160,8 @@ Do not use them in new code.
/command/load_command
/command/make_directory
/command/output_required_files
/command/qt_wrap_cpp
/command/qt_wrap_ui
/command/remove
/command/subdir_depends
/command/subdirs