diff options
Diffstat (limited to 'src/qml/doc/src/cmake')
-rw-r--r-- | src/qml/doc/src/cmake/cmake-properties.qdoc | 18 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/cmake-variables.qdoc | 2 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_add_qml_module.qdoc | 10 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_add_qml_plugin.qdoc | 2 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc | 4 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc | 4 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_generate_foreign_qml_types.qdoc | 11 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_import_qml_plugins.qdoc | 2 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_query_qml_module.qdoc | 2 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_target_compile_qml_to_cpp.qdoc | 2 | ||||
-rw-r--r-- | src/qml/doc/src/cmake/qt_target_qml_sources.qdoc | 2 |
11 files changed, 36 insertions, 23 deletions
diff --git a/src/qml/doc/src/cmake/cmake-properties.qdoc b/src/qml/doc/src/cmake/cmake-properties.qdoc index 0b8d2c9367..98858ca6d1 100644 --- a/src/qml/doc/src/cmake/cmake-properties.qdoc +++ b/src/qml/doc/src/cmake/cmake-properties.qdoc @@ -13,7 +13,7 @@ CMake source file properties: /*! -\page cmake-source-file-property-QT_QML_INTERNAL_TYPE.html +\page cmake-source-file-property-qt-qml-internal-type.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_INTERNAL_TYPE @@ -30,7 +30,7 @@ Set this property to \c TRUE to indicate that the \c{.qml} file provides an inte /*! -\page cmake-source-file-property-QT_QML_SINGLETON_TYPE.html +\page cmake-source-file-property-qt-qml-singleton-type.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SINGLETON_TYPE @@ -53,7 +53,7 @@ how to set the \c QT_QML_SINGLETON_TYPE property. /*! -\page cmake-source-file-property-QT_QML_SKIP_CACHEGEN.html +\page cmake-source-file-property-qt-qml-skip-cachegen.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SKIP_CACHEGEN @@ -72,7 +72,7 @@ The file will still be added to the \c target as a resource in uncompiled form /*! -\page cmake-source-file-property-QT_QML_SKIP_QMLDIR_ENTRY.html +\page cmake-source-file-property-qt-qml-skip-qmldir-entry.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SKIP_QMLDIR_ENTRY @@ -91,7 +91,7 @@ the \c{.qml} file from being added as a type to the QML module's typeinfo file /*! -\page cmake-source-file-property-QT_QML_SKIP_QMLLINT.html +\page cmake-source-file-property-qt-qml-skip-qmllint.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SKIP_QMLLINT @@ -109,7 +109,7 @@ Set this property to \c TRUE to prevent the file from being included in /*! -\page cmake-source-file-property-QT_QML_SOURCE_TYPENAME.html +\page cmake-source-file-property-qt-qml-source-typename.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SOURCE_TYPENAME @@ -126,7 +126,7 @@ Use this property to override the \c QML type name provided by this file. /*! -\page cmake-source-file-property-QT_QML_SOURCE_VERSIONS.html +\page cmake-source-file-property-qt-qml-source-versions.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SOURCE_VERSIONS @@ -145,7 +145,7 @@ version after the \c{.0} release, specify those versions using this property. /*! -\page cmake-source-file-property-QT_QMLTC_FILE_BASENAME.html +\page cmake-source-file-property-qt-qmltc-file-basename.html \ingroup cmake-source-file-properties-qtqml \title QT_QMLTC_FILE_BASENAME @@ -163,7 +163,7 @@ conflicting file names. */ /*! -\page cmake-source-file-property-QT_QML_SKIP_TYPE_COMPILER.html +\page cmake-source-file-property-qt-qml-skip-type-compiler.html \ingroup cmake-source-file-properties-qtqml \title QT_QML_SKIP_TYPE_COMPILER diff --git a/src/qml/doc/src/cmake/cmake-variables.qdoc b/src/qml/doc/src/cmake/cmake-variables.qdoc index 15f73f074e..574b24e970 100644 --- a/src/qml/doc/src/cmake/cmake-variables.qdoc +++ b/src/qml/doc/src/cmake/cmake-variables.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page cmake-variable-QT_QML_OUTPUT_DIRECTORY.html +\page cmake-variable-qt-qml-output-directory.html \ingroup cmake-variables-qtqml \title QT_QML_OUTPUT_DIRECTORY diff --git a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc index 20c343a1bd..e20876fede 100644 --- a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc +++ b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_qml_module.html +\page qt-add-qml-module.html \ingroup cmake-commands-qtqml \title qt_add_qml_module @@ -364,8 +364,12 @@ been created. When \c NO_CREATE_PLUGIN_TARGET is given, \c PLUGIN_TARGET must also be provided to explicitly name the plugin target. Every QML module must define a \c URI. It should be specified in dotted URI -notation, such as \c{QtQuick.Layouts}. It must not contain anything other than -alphanumeric or dot characters. Other QML modules may use this name in +notation, such as \c{QtQuick.Layouts}. Each segment must be a well-formed +ECMAScript Identifier Name. This means, for example, the segments +must not start with a number and they must not contain \e{-} (minus) +characters. As the \c URI will be translated into directory names, you +should restrict it to alphanumeric characters of the latin alphabet, +underscores, and dots. Other QML modules may use this name in \l{qtqml-syntax-imports.html}{import statements} to import the module. The \c URI will be used in the \c module line of the generated \l{Module Definition qmldir Files}{qmldir} file. The \c URI is also used to diff --git a/src/qml/doc/src/cmake/qt_add_qml_plugin.qdoc b/src/qml/doc/src/cmake/qt_add_qml_plugin.qdoc index cb98406a9d..2ce744559c 100644 --- a/src/qml/doc/src/cmake/qt_add_qml_plugin.qdoc +++ b/src/qml/doc/src/cmake/qt_add_qml_plugin.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_qml_plugin.html +\page qt-add-qml-plugin.html \ingroup cmake-commands-qtqml \title qt_add_qml_plugin diff --git a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc index 92da84733e..cc3c61863c 100644 --- a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc +++ b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_deploy_qml_imports.html +\page qt-deploy-qml-imports.html \ingroup cmake-commands-qtqml \title qt_deploy_qml_imports @@ -18,7 +18,7 @@ project. \preliminarycmakecommand -\include cmake-qml-qt-finalize-target-warning.cmake +\include cmake-qml-qt-finalize-target-warning.qdocinc \section1 Synopsis diff --git a/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc b/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc index 493a4fc029..fc78baddcd 100644 --- a/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc +++ b/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_generate_deploy_qml_app_script.html +\page qt-generate-deploy-qml-app-script.html \ingroup cmake-commands-qtqml \title qt_generate_deploy_qml_app_script @@ -15,7 +15,7 @@ \cmakecommandsince 6.3 \preliminarycmakecommand -\include cmake-qml-qt-finalize-target-warning.cmake +\include cmake-qml-qt-finalize-target-warning.qdocinc \section1 Synopsis diff --git a/src/qml/doc/src/cmake/qt_generate_foreign_qml_types.qdoc b/src/qml/doc/src/cmake/qt_generate_foreign_qml_types.qdoc index 856f0fe2b1..9bd412d36d 100644 --- a/src/qml/doc/src/cmake/qt_generate_foreign_qml_types.qdoc +++ b/src/qml/doc/src/cmake/qt_generate_foreign_qml_types.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_generate_foreign_qml_types.html +\page qt-generate-foreign-qml-types.html \ingroup cmake-commands-qtqml \title qt_generate_foreign_qml_types @@ -67,4 +67,13 @@ the \c QML_ELEMENT macro). The effect is equivalent to using \c QML_FOREIGN with custom structs in the QML library to expose the types. + +\note In order to implement custom behavior, such as exposing an existing +singleton instance with its own life cycle to QML, you should add custom types +to your QML library (mylib_declarative in the above example). In turn, you +should omit the \l QML_ELEMENT and similar macros from the original C++ classes +so that qt_generate_foreign_qml_types() does not generate more QML integration +structs for them. The QML macros, as well as any singleton factory functions, +can be added to the structs that contain the \l QML_FOREIGN. + */ diff --git a/src/qml/doc/src/cmake/qt_import_qml_plugins.qdoc b/src/qml/doc/src/cmake/qt_import_qml_plugins.qdoc index b45e47ce55..8d6b32f903 100644 --- a/src/qml/doc/src/cmake/qt_import_qml_plugins.qdoc +++ b/src/qml/doc/src/cmake/qt_import_qml_plugins.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_import_qml_plugins.html +\page qt-import-qml-plugins.html \ingroup cmake-commands-qtqml \title qt_import_qml_plugins diff --git a/src/qml/doc/src/cmake/qt_query_qml_module.qdoc b/src/qml/doc/src/cmake/qt_query_qml_module.qdoc index 50996745c8..44d0a7f8da 100644 --- a/src/qml/doc/src/cmake/qt_query_qml_module.qdoc +++ b/src/qml/doc/src/cmake/qt_query_qml_module.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_query_qml_module.html +\page qt-query-qml-module.html \ingroup cmake-commands-qtqml \title qt_query_qml_module diff --git a/src/qml/doc/src/cmake/qt_target_compile_qml_to_cpp.qdoc b/src/qml/doc/src/cmake/qt_target_compile_qml_to_cpp.qdoc index d989c80fcf..0ef6e421ed 100644 --- a/src/qml/doc/src/cmake/qt_target_compile_qml_to_cpp.qdoc +++ b/src/qml/doc/src/cmake/qt_target_compile_qml_to_cpp.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_target_compile_qml_to_cpp.html +\page qt-target-compile-qml-to-cpp.html \ingroup cmake-commands-qtqml \title qt_target_compile_qml_to_cpp diff --git a/src/qml/doc/src/cmake/qt_target_qml_sources.qdoc b/src/qml/doc/src/cmake/qt_target_qml_sources.qdoc index 126c9767a0..35854d4b95 100644 --- a/src/qml/doc/src/cmake/qt_target_qml_sources.qdoc +++ b/src/qml/doc/src/cmake/qt_target_qml_sources.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_target_qml_sources.html +\page qt-target-qml-sources.html \ingroup cmake-commands-qtqml \title qt_target_qml_sources |