aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSami Shalayel <sami.shalayel@qt.io>2025-02-28 09:58:29 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2025-03-10 10:59:43 +0000
commitbe60521924ffc305afe61d804428aefbac9e1393 (patch)
tree099b34574243cc444f7b7f66929c828664e58d55
parent47fc3baf9b16f988f34c8f63b5da3e681413412b (diff)
doc: add links to "Port QML Modules to CMake" page
Add links to "Port QML modules to CMake" page so people know that they shouldn't write QML Modules and qmldir files by hand when they use CMake. Its only required for QMake. Also link the "Modern QML module" and "Port QML modules to CMake" pages as \sa to the documentation about QML modules. Task-number: QTBUG-133547 Change-Id: I36298cd58b6206c59d6a6545cb55fb2f97c47153 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit cd38ca407654c7b5ebd497185faadd76012fa9a8) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit d9f471395e9b6b5bdf91d925d2f7c4751b60cd36)
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/identifiedmodules.qdoc2
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/legacymodules.qdoc3
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc3
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/topic.qdoc4
-rw-r--r--src/qml/doc/src/qtqml-writing-a-module.qdoc2
5 files changed, 12 insertions, 2 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/identifiedmodules.qdoc b/src/qml/doc/src/qmllanguageref/modules/identifiedmodules.qdoc
index 93461f1ed7..76c3d4090d 100644
--- a/src/qml/doc/src/qmllanguageref/modules/identifiedmodules.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/identifiedmodules.qdoc
@@ -174,5 +174,5 @@ statement:
import com.example.CustomUi
\endqml
+\sa {Modern QML modules}, {Port QML modules to CMake}
*/
-
diff --git a/src/qml/doc/src/qmllanguageref/modules/legacymodules.qdoc b/src/qml/doc/src/qmllanguageref/modules/legacymodules.qdoc
index 51bb424d22..45fcb87835 100644
--- a/src/qml/doc/src/qmllanguageref/modules/legacymodules.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/legacymodules.qdoc
@@ -55,5 +55,6 @@ A located legacy module may reside on the local file system or on the
network and can be referred to by a URL that specifies the file system path or
network URL.
-*/
+\sa {Modern QML modules}, {Port QML modules to CMake}
+*/
diff --git a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
index 3e53b4f6a7..2c9cf8e930 100644
--- a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
@@ -19,6 +19,9 @@ module. For more information about the first form of \c qmldir file, see
\section1 Contents of a Module Definition qmldir File
+\note Use the CMake API to \l{Port QML modules to CMake}{generate qmldir files}. Write your \c
+qmldir manually only if you need to use \c qmake.
+
A \c qmldir file is a plain-text file that contains the following commands:
\list
diff --git a/src/qml/doc/src/qmllanguageref/modules/topic.qdoc b/src/qml/doc/src/qmllanguageref/modules/topic.qdoc
index 449acb3f81..cf87e66077 100644
--- a/src/qml/doc/src/qmllanguageref/modules/topic.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/topic.qdoc
@@ -26,6 +26,9 @@ Defining of a QML module allows:
\section1 Defining a QML Module
+\note Use the \l{Port QML modules to CMake}{CMake API} to define a QML Module.
+Define your QML module manually only if you need to use \c qmake.
+
A module is defined by a \l{qtqml-modules-qmldir.html}
{module definition qmldir file}. Each module has an associated type
namespace, which is the module's identifier. A module can provide QML object
@@ -78,4 +81,5 @@ register any types that the plugin provides, but must not do anything else
See \l{qtqml-modules-cppplugins.html}{Creating C++ Plugins For QML} for more information.
+\sa {Modern QML modules}, {Port QML modules to CMake}
*/
diff --git a/src/qml/doc/src/qtqml-writing-a-module.qdoc b/src/qml/doc/src/qtqml-writing-a-module.qdoc
index f467651ed3..62b3c12769 100644
--- a/src/qml/doc/src/qtqml-writing-a-module.qdoc
+++ b/src/qml/doc/src/qtqml-writing-a-module.qdoc
@@ -458,4 +458,6 @@ linker does not drop parts of the module in various scenarios.
As the plugin creates an image provider, it no longer has a trivial
\c initializeEngine function. Therefore, the plugin is no longer optional.
+\sa {Changes to Qt QML}, {Modern QML modules}, {Port QML modules to CMake}
+
*/