summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@qt.io>2021-09-08 18:17:56 +1000
committerCraig Scott <craig.scott@qt.io>2021-09-10 17:09:12 +1000
commit8b64cbd0abcd5398b81c4b58bcaeefe3b887aa6c (patch)
treef65a3a7815cace15e2806f3671dea54da8ab4674
parentabd4581abe24d81662c4daef961128fe185fe0ec (diff)
Remove inline docs for qt_import_plugins() to avoid duplication
Don't maintain two copies of the docs for qt_import_plugins() in separate places. Remove the inline docs because they are not the canonical ones that the user docs contain. Also remove the TODO and qml plugins. Those are now handled by a separate command, qt_import_qml_plugins(). Add a "see also" link to assist in discoverability. Task-number: QTBUG-95712 Change-Id: I3bb872f77a1b57fd5f2f4fe1355625c47e44a351 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit 2e4d8d8ec52a56470beeb43b8f08f12953a17d4f)
-rw-r--r--src/corelib/Qt6CoreMacros.cmake19
-rw-r--r--src/corelib/doc/src/cmake/qt_import_plugins.qdoc2
2 files changed, 2 insertions, 19 deletions
diff --git a/src/corelib/Qt6CoreMacros.cmake b/src/corelib/Qt6CoreMacros.cmake
index aebff888db..e4ecb4d459 100644
--- a/src/corelib/Qt6CoreMacros.cmake
+++ b/src/corelib/Qt6CoreMacros.cmake
@@ -834,25 +834,6 @@ function(_qt_internal_disable_static_default_plugins target)
set_target_properties(${target} PROPERTIES QT_DEFAULT_PLUGINS 0)
endfunction()
-# This function is used to indicate which plug-ins are going to be
-# used by a given target.
-# This allows static linking to a correct set of plugins.
-# Options :
-# NO_DEFAULT: disable linking against any plug-in by default for that target, e.g. no platform plug-in.
-# INCLUDE <list of additional plug-ins to be linked against>
-# EXCLUDE <list of plug-ins to be removed from the default set>
-# INCLUDE_BY_TYPE <type> <included plugins>
-# EXCLUDE_BY_TYPE <type to be excluded>
-#
-# Example :
-# qt_import_plugins(myapp
-# INCLUDE Qt::QCocoaIntegrationPlugin
-# EXCLUDE Qt::QMinimalIntegrationPlugin
-# INCLUDE_BY_TYPE imageformats Qt::QGifPlugin Qt::QJpegPlugin
-# EXCLUDE_BY_TYPE sqldrivers
-# )
-
-# TODO : support qml plug-ins.
function(qt6_import_plugins target)
cmake_parse_arguments(arg "NO_DEFAULT" "" "INCLUDE;EXCLUDE;INCLUDE_BY_TYPE;EXCLUDE_BY_TYPE" ${ARGN})
diff --git a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
index 0b3c2011b1..9b109e5f90 100644
--- a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
+++ b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
@@ -90,4 +90,6 @@ In the snippet above, the following occurs with the executable \c myapp:
overridden to only include Qt6::QGifPlugin and Qt6::QJpegPlugin.
\li All \c sqldrivers plugins are excluded from automatic importing.
\endlist
+
+\sa{qt6_import_qml_plugins}{qt_import_qml_plugins()}
*/