aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2024-03-18 21:34:32 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2024-03-19 00:35:36 +0100
commitf0fa7f37ea85402671805e54c0fa9c0a61e8e117 (patch)
treed8ed23b32fd60c8521699f6b9f6c56134b5b646a
parent9518e940f1c188820d1a405f9557988214888a4f (diff)
doc: add page for pyside6-qmltyperegistrarHEADdev
Change-Id: I681454e28eb0eec8a920a415719c195549f403fc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
-rw-r--r--sources/pyside6/doc/gettingstarted/package_details.rst4
-rw-r--r--sources/pyside6/doc/tools/pyside-qmltyperegistrar.rst17
2 files changed, 19 insertions, 2 deletions
diff --git a/sources/pyside6/doc/gettingstarted/package_details.rst b/sources/pyside6/doc/gettingstarted/package_details.rst
index 8551cdcd6..4eae2ea96 100644
--- a/sources/pyside6/doc/gettingstarted/package_details.rst
+++ b/sources/pyside6/doc/gettingstarted/package_details.rst
@@ -139,8 +139,8 @@ QML Development
that verifies the syntactic validity of QML files.
- .. grid-item-card:: ``pyside6-qmlregistrar``
- :link: pyside6-qmlregistrar
+ .. grid-item-card:: ``pyside6-qmltyperegistrar``
+ :link: pyside6-qmltyperegistrar
:link-type: ref
to read metatypes files and generate files that contain the necessary
diff --git a/sources/pyside6/doc/tools/pyside-qmltyperegistrar.rst b/sources/pyside6/doc/tools/pyside-qmltyperegistrar.rst
new file mode 100644
index 000000000..0e8d66bd5
--- /dev/null
+++ b/sources/pyside6/doc/tools/pyside-qmltyperegistrar.rst
@@ -0,0 +1,17 @@
+.. _pyside6-qmltyperegistrar:
+
+pyside6-qmltyperegistrar
+========================
+
+``pyside6-qmltyperegistrar`` is a command line tool that wraps the
+``qmltyperegistrar`` tool of Qt.
+
+It takes the file produced by :ref:`pyside6-metaobjectdump`
+as input and generates C++ code to register C++ classes to QML
+and a ``.qmltypes`` file containing a JSON description of the
+classes. For Qt for Python, only the ``.qmltypes`` file
+is of interest as input for :ref:`pyside6-qmllint`.
+
+The tool is automatically run by the :ref:`pyside6-project` tool
+when passing the ``qmllint`` argument instructing it to check
+the QML source files.