diff options
| author | Ulf Hermann <ulf.hermann@qt.io> | 2020-05-18 19:21:05 +0200 |
|---|---|---|
| committer | Ulf Hermann <ulf.hermann@qt.io> | 2020-05-19 08:37:02 +0200 |
| commit | fd85f0dae95d36d080b986812d6d97184d1329db (patch) | |
| tree | 6e2bd5f7fcc069b7aca31bb84a5207d27c18a893 /src/qml/doc/src | |
| parent | 03f3af76304f2d7eaf8938e694c677bd9ba23753 (diff) | |
Remove the last traces of qmlplugindump from the documentation
People should use qmltyperegistrar instead. We have plenty of
documentation for it.
Change-Id: Ib74909cb31cf856cbf80ec964959126638af08e9
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/qml/doc/src')
| -rw-r--r-- | src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc | 24 |
1 files changed, 9 insertions, 15 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc index 99c7fa5621..396a83b821 100644 --- a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc +++ b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc @@ -390,27 +390,21 @@ error checking and other functionality to users of your module. Any module that uses plugins should also ship a type description file. The best way to create a qmltypes file for your module is to generate it -using the \c qmlplugindump tool that is provided with Qt. +using the build system and the \l QML_ELEMENT macros. Example: -If your module is in \c /tmp/imports/My/Module, you could run -\code -qmlplugindump My.Module 1.0 /tmp/imports > /tmp/imports/My/Module/mymodule.qmltypes -\endcode -to generate type information for your module. Afterwards, add the line +If your module is in \c /tmp/imports/My/Module, a file caled \c plugins.qmltypes +should be generated alongside the actual plugin binary. + +Add the line \code -typeinfo mymodule.qmltypes +typeinfo plugins.qmltypes \endcode to \c /tmp/imports/My/Module/qmldir to register it. -While the qmldump tool covers most cases, it does not work if: -\list -\li The plugin uses a \c{QQmlCustomParser}. The component that uses - the custom parser will not get its members documented. -\li The plugin can not be loaded. In particular if you cross-compiled - the plugin for a different architecture, qmldump will not be able to - load it. -\endlist +While the automatic generation covers most cases, it does not work if the plugin +uses a \c{QQmlCustomParser}. The component that uses the custom parser will not +get its members documented. In case you have to create a qmltypes file manually or need to adjust an existing one, this is the file format: |