aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/extras/QtCore.ClassInfo.rst
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2019-11-07 09:54:13 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2019-11-18 11:12:35 +0100
commit688176a3c35f49c7c087ca2f0e8c841e72133176 (patch)
tree04d5939c747ccd748cd14889c192f0485cfe3320 /sources/pyside2/doc/extras/QtCore.ClassInfo.rst
parent91f62b1db2bdfe9b4eaeb291f31c97c1767fa3fd (diff)
Doc: Drop PySide prefix from the RST filenames
Shiboken appends the content in these RSTs to the module index pages that it generates. In addition, - updated the snippets, extras, and additional docs passed to the Shiboken call. - moved the copy_directory command right before the shiboken call. Change-Id: I45222ba7d0798105a764d7692d466f7a2a105d77 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/extras/QtCore.ClassInfo.rst')
-rw-r--r--sources/pyside2/doc/extras/QtCore.ClassInfo.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/sources/pyside2/doc/extras/QtCore.ClassInfo.rst b/sources/pyside2/doc/extras/QtCore.ClassInfo.rst
new file mode 100644
index 000000000..d2267be9c
--- /dev/null
+++ b/sources/pyside2/doc/extras/QtCore.ClassInfo.rst
@@ -0,0 +1,23 @@
+.. module:: PySide2.QtCore
+.. _ClassInfo:
+
+ClassInfo
+*********
+
+This class is used to associates extra information to the class, which is available
+using QObject.metaObject(). Qt and PySide doesn't use this information.
+
+The extra information takes the form of a dictionary with key and value in a literal string.
+
+.. note:: This Class is a implementation of Q_CLASSINFO macro.
+
+
+Example
+-------
+
+::
+
+ @ClassInfo(Author='PySide Team', URL='http://www.pyside.org')
+ class MyObject(QObject):
+ ...
+