Extend the Q_IMPORT_QML_PLUGIN documentation
Add the explanation what is PluginName and how it's computed when using
the modern QML API.
Fixes: QTBUG-119372
Pick-to: 6.6 6.5 6.2
Change-Id: I7346f7b7f82c717ee79b07f4dcec0c0d1dc733b2
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit 48241a49d9
)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
parent
91a25a8e3c
commit
db9171d0c3
|
@ -166,8 +166,20 @@ void QQmlEngineExtensionPlugin::initializeEngine(QQmlEngine *engine, const char
|
|||
\since 6.2
|
||||
\relates QQmlEngineExtensionPlugin
|
||||
|
||||
Ensures the plugin whose metadata-declaring class is named \a PluginName
|
||||
is linked into static builds.
|
||||
Ensures the plugin whose metadata-declaring plugin extension class is named
|
||||
\a PluginName is linked into static builds. For the modules created using
|
||||
\l qt_add_qml_module, the default plugin extension class name is computed
|
||||
from the QML module URI by replacing dots with underscores, unless the
|
||||
\c CLASS_NAME argument is specified.
|
||||
|
||||
For example:
|
||||
\badcode
|
||||
qt_add_qml_module(myplugin
|
||||
# The plugin extension class name in this case is my_Company_QmlComponents.
|
||||
URI my.Company.QmlComponents
|
||||
...
|
||||
)
|
||||
\endcode
|
||||
|
||||
\sa Q_IMPORT_PLUGIN
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue