From 06b948036932abce31ee23126af9e2c91205248c Mon Sep 17 00:00:00 2001
From: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Date: Fri, 19 Oct 2018 16:58:51 +0200
Subject: Add documentation related QPixmap.loadFromData

Task-number: PYSIDE-840
Change-Id: I637186335123500013a265b8a6f6554dfdceb225
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
---
 sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml')

diff --git a/sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml b/sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml
index 1d09dee7a..6818612cb 100644
--- a/sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml
+++ b/sources/pyside2/PySide2/QtGui/typesystem_gui_common.xml
@@ -602,6 +602,18 @@
     <modify-function signature="operator!()const" remove="all"/>
 
     <modify-function signature="loadFromData(const uchar*,uint,const char*,QFlags&lt;Qt::ImageConversionFlag&gt;)">
+        <inject-documentation format="target" mode="append">
+        This method must be used with an QPixmap object, not the class:
+
+        ::
+
+            # Wrong
+            pixmap = QPixmap.loadFromData(...)
+
+            # Right
+            pixmap = QPixmap().loadFromData(...)
+
+        </inject-documentation>
       <modify-argument index="1">
         <replace-type modified-type="PyBytes"/>
         <conversion-rule class="native">
-- 
cgit v1.2.3