From 37a66236d2fd0d671c8ee37c5f9512d30f18c179 Mon Sep 17 00:00:00 2001
From: Ulf Hermann <ulf.hermann@qt.io>
Date: Tue, 3 Mar 2020 13:57:30 +0100
Subject: qmake: Document qmltypes and metatypes

Task-number: QTBUG-81615
Fixes: QTBUG-82305
Change-Id: I0a411ff2ebc2dbf5462fa110b1eb70a1876b6ae5
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
---
 qmake/doc/src/qmake-manual.qdoc | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'qmake')

diff --git a/qmake/doc/src/qmake-manual.qdoc b/qmake/doc/src/qmake-manual.qdoc
index 1e1e23495c..351009bd1c 100644
--- a/qmake/doc/src/qmake-manual.qdoc
+++ b/qmake/doc/src/qmake-manual.qdoc
@@ -1111,6 +1111,15 @@
     \row \li designer \li The target is a plugin for \QD.
     \row \li no_lflags_merge \li Ensures that the list of libraries stored in the
          \c LIBS variable is not reduced to a list of unique values before it is used.
+    \row \li metatypes \li Create a \c {<name>_metatypes.json} file for the
+         current project. \c {<name>} is the all lowercase base name of
+         \l TARGET.
+    \row \li qmltypes \li Automatically register QML types defined in C++.
+         For more information, see \l {Defining QML Types from C++}.
+         Also, create a \c {<template>.qmltypes} file for the current
+         project. \c <template> will be \c plugins (plural, for historical
+         reasons) if \c plugin is set, or the value of \l TEMPLATE otherwise.
+         \c qmltypes implies \c metatypes.
     \endtable
 
     These options define specific features on Windows only:
@@ -2579,6 +2588,32 @@
 
     For more information, see \l {Expressing Supported iOS Versions}.
 
+    \section1 QML_IMPORT_MAJOR_VERSION
+
+    Specifies the major version to be used for automatically generated QML type
+    registrations. For more information, see \l {Defining QML Types from C++}.
+
+    \section1 QML_IMPORT_MINOR_VERSION
+
+    When automatically registering QML types defined in C++, register an
+    additional version of the module using this minor version. Generally,
+    minor versions to be registered are inferred from the meta objects.
+
+    You can use this variable if the meta objects have not changed and you
+    still want to import a QML module with a newer minor version number. For
+    example, \c MyModule metaobjects are at \c 1.1 level, but you want to import
+    the module as \c 1.3.
+
+    \section1 QML_IMPORT_VERSION
+
+    Specifies \l QML_IMPORT_MAJOR_VERSION and \l QML_IMPORT_MINOR_VERSION as a
+    \c {<major>.<minor>} version string.
+
+    \section1 QML_IMPORT_NAME
+
+    Specifies the module name to be used for automatically generated QML type
+    registrations. For more information, see \l {Defining QML Types from C++}.
+
     \section1 QT
 
     Specifies the \l{All Modules}{Qt modules} that are used by your project. For
-- 
cgit v1.2.3