diff options
author | Friedemann Kleint <[email protected]> | 2024-10-23 09:04:59 +0200 |
---|---|---|
committer | Friedemann Kleint <[email protected]> | 2024-10-24 09:44:57 +0200 |
commit | 0f1756769b66152c561233bb2de1ce3e21a8321f (patch) | |
tree | e4934e2af44bb0a90cc3ba43808abdf39618d96b /sources/pyside6/doc/extras/QtQml.QmlElement.rst | |
parent | 35eb8b218405cec8610394add763d1d4297ae24a (diff) |
Fix extra class documentation
- Add indentation
- Use refs for classes and decorators
- Fix method/parameter listings
Pick-to: 6.8
Change-Id: Iaada9d40e734935d5e56d75fc2a9b1a72da58e33
Reviewed-by: Cristian Maureira-Fredes <[email protected]>
Reviewed-by: Shyamnath Premnadh <[email protected]>
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.QmlElement.rst')
-rw-r--r-- | sources/pyside6/doc/extras/QtQml.QmlElement.rst | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlElement.rst b/sources/pyside6/doc/extras/QtQml.QmlElement.rst index 66397b2d9..a7443b49f 100644 --- a/sources/pyside6/doc/extras/QtQml.QmlElement.rst +++ b/sources/pyside6/doc/extras/QtQml.QmlElement.rst @@ -1,25 +1,25 @@ .. currentmodule:: PySide6.QtQml .. py:decorator:: QmlElement -This decorator registers a class it is attached to for use in QML, using -global variables to specify the import name and version. + This decorator registers a class it is attached to for use in QML, using + global variables to specify the import name and version. -.. code-block:: python + .. code-block:: python - QML_IMPORT_NAME = "com.library.name" - QML_IMPORT_MAJOR_VERSION = 1 - QML_IMPORT_MINOR_VERSION = 0 # Optional + QML_IMPORT_NAME = "com.library.name" + QML_IMPORT_MAJOR_VERSION = 1 + QML_IMPORT_MINOR_VERSION = 0 # Optional - @QmlElement - class ClassForQml(QObject): - # ... + @QmlElement + class ClassForQml(QObject): + # ... -Afterwards the class may be used in QML: + Afterwards the class may be used in QML: -.. code-block:: python + .. code-block:: python - import com.library.name 1.0 + import com.library.name 1.0 - ClassForQml { - // ... - } + ClassForQml { + // ... + } |