[Development] Maintainers: Make sure QML import in documentation and plugins.qmltypes are up to date for 5.11

Kai Koehne Kai.Koehne at qt.io
Wed Apr 18 09:52:27 CEST 2018


If your respective module has a QML import and there's new API / a new import version, please make sure now that both the documentation and the tooling support accommodates for that. 

For documentation, it is usually enough to bump the import in the "\qmlmodule XXX major.minor" declaration, and in the module description. See e.g. https://codereview.qt-project.org/#/c/226631/1 .

This will make sure that the 'landing page' of your module recommends the latest import, and that documentation for every single qml type will start with the latest up to date import statement.

plugins.qmltypes is the mechanism how Qt Creator knows about new types and properties. That is, if it doesn't get updated, the new import and new types, properties and methods will be underlined as unknown in Qt Creator.

To update it, it is usually enough to run 

  [n]make qmltypes

In the build folder where the plugins.qmltypes file belongs to.  This is btw also a good way to do an API review. In particular, to check whether all new properties, signals ... have a proper REVISION / are properly versioned.



Kai Koehne, Senior Manager R&D | The Qt Company

The Qt Company GmbH, Rudower Chaussee 13, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho. Sitz der
Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, 
HRB 144331 B

More information about the Development mailing list