diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-04-22 14:25:09 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2024-04-22 18:58:35 +0000 |
| commit | d8db90319c87d80b76f901e98a9b4a587741e733 (patch) | |
| tree | 8ceb9be719f6aa465bc5ad9b7201fa6b53e36692 | |
| parent | 6bcacd5b8394ca2139c7bb606e914c58e9dba58f (diff) | |
Documentation: Fix ClassInfo to be a proper decorator
Task-number: PYSIDE-1106
Change-Id: I298769db5455368fca6890571546d4cf74ace957
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
(cherry picked from commit 432c4b10bf77e8290b95d8ce2e01db0d80a4445a)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -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 |