diff options
| author | Fabian Kosmale <fabian.kosmale@qt.io> | 2025-04-08 12:08:17 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2025-04-14 10:23:23 +0000 |
| commit | 9ccd3c6d87f106574832a7267b13abb478c7d64e (patch) | |
| tree | 4b54ddacb4d0aefbd853c169bc3d7ef9633f0245 | |
| parent | d01b4c7d5852876579987145e1c734ec9d0e5099 (diff) | |
QQmlEngineExtensionPlugin: Clarify documentation
Try to be more explicit about the naming of the type registration
function.
Change-Id: Ia17ec3851a099d55021f20328c74952ae5f3b634
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
(cherry picked from commit 2df3eeb6060f480cbba682b1be9b036af3315b75)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit 2de96f7034e263c1e2644529a7adbd2357c48a8a)
| -rw-r--r-- | src/qml/doc/src/qmllanguageref/modules/qqmlextensionplugin.qdocinc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/qqmlextensionplugin.qdocinc b/src/qml/doc/src/qmllanguageref/modules/qqmlextensionplugin.qdocinc index 771d520f8a..937e110ee9 100644 --- a/src/qml/doc/src/qmllanguageref/modules/qqmlextensionplugin.qdocinc +++ b/src/qml/doc/src/qmllanguageref/modules/qqmlextensionplugin.qdocinc @@ -48,7 +48,11 @@ call to disable the generation of the default plugin. The linker might erroneously remove the generated type registration function as an optimization. You can prevent that by declaring a synthetic -volatile pointer to the function somewhere in your code. If your module is +volatile pointer to the function somewhere in your code. The function is +generated by \l{qmltyperegistrar}, and is named \c{qml_register_types_} +concatenated with the module URI, with any dots replaced by underscores. + +If your module is called "my.module", you would add the forward declaration in global scope: \code |