summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrenato araujo <renato@renatoPC.indt.org>2011-05-30 16:25:38 -0300
committerrenato araujo <renato@renatoPC.indt.org>2011-05-30 16:26:48 -0300
commit2e985afb3aee480e4b7e1626b34bd998027807b8 (patch)
tree2fa24a27704406fb9496d5394e834fa29ffc849d
parent35630f32ffc6d2d0e97d6f1ce40f0c32db96d06f (diff)
downloadpyside-2e985afb3aee480e4b7e1626b34bd998027807b8.tar.gz
pyside-2e985afb3aee480e4b7e1626b34bd998027807b8.tar.xz
pyside-2e985afb3aee480e4b7e1626b34bd998027807b8.zip
Created ClassInfo documentation.
Reviewer: Luciano Wolf <luciano.wolf@openbossa.org> Hugo Parente <hugo.lima@openbossa.org>
-rw-r--r--doc/extras/PySide.QtCore.ClassInfo.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/extras/PySide.QtCore.ClassInfo.rst b/doc/extras/PySide.QtCore.ClassInfo.rst
new file mode 100644
index 0000000..39edf3f
--- /dev/null
+++ b/doc/extras/PySide.QtCore.ClassInfo.rst
@@ -0,0 +1,23 @@
+.. module:: PySide.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):
+ ...
+