diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-04-22 14:25:09 +0200 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-04-22 15:13:28 +0200 |
commit | 432c4b10bf77e8290b95d8ce2e01db0d80a4445a (patch) | |
tree | fb4d46c00ed86900ed13abbf35f2a9be37aea70f /sources/pyside6/doc | |
parent | 94c21428779b5433d84c77d7b42d3652c4228709 (diff) |
Documentation: Fix ClassInfo to be a proper decorator
Pick-to: 6.7
Task-number: PYSIDE-1106
Change-Id: I298769db5455368fca6890571546d4cf74ace957
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Diffstat (limited to 'sources/pyside6/doc')
-rw-r--r-- | sources/pyside6/doc/extras/QtCore.ClassInfo.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/sources/pyside6/doc/extras/QtCore.ClassInfo.rst b/sources/pyside6/doc/extras/QtCore.ClassInfo.rst index aa080aa08..75445e1fc 100644 --- a/sources/pyside6/doc/extras/QtCore.ClassInfo.rst +++ b/sources/pyside6/doc/extras/QtCore.ClassInfo.rst @@ -1,11 +1,9 @@ .. currentmodule:: PySide6.QtCore -.. _ClassInfo: +.. py:decorator:: ClassInfo -ClassInfo -********* - -This class is used to associate extra information to the class, which is available -using QObject.metaObject(). Qt and PySide doesn't use this information. +This decorator is used to associate extra information to the class, which is available +using ``QObject.metaObject()``. This information is used by the +*Qt D-Bus* and *Qt Qml* modules. The extra information takes the form of a dictionary with key and value in a literal string. @@ -16,7 +14,7 @@ If the key needs to contain special characters (spaces, commas, '::', start with it is also possible to pass a python dictionary with arbitrary strings for both the key and value and enabling special characters in the key. -.. note:: This Class is a implementation of Q_CLASSINFO macro. +.. note:: This decorator is a implementation of the Q_CLASSINFO macro. Example |