Fix PyQGIS docs for colorFromMimeData

qgis · Oct 23, 2020 · 395718f · 395718f
1 parent f86a2e9
commit 395718f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 8 deletions.
diff --git a/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in b/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in
@@ -566,16 +566,14 @@ mime data's text with the color's hex code.
 .. versionadded:: 2.5
 %End
 
-    static QColor colorFromMimeData( const QMimeData *data, bool &hasAlpha );
+    static QColor colorFromMimeData( const QMimeData *data, bool &hasAlpha /Out/ );
 %Docstring
 Attempts to parse mime data as a color
 
 :param data: mime data to parse
-:param hasAlpha: will be set to ``True`` if mime data was interpreted as a color containing
-                 an explicit alpha value
 
-:return: valid color if mimedata could be interpreted as a color, otherwise an
-         invalid color
+:return: - valid color if mimedata could be interpreted as a color, otherwise an invalid color
+         - hasAlpha: will be set to ``True`` if mime data was interpreted as a color containing an explicit alpha value
 
 .. versionadded:: 2.5
 %End

diff --git a/src/core/symbology/qgssymbollayerutils.h b/src/core/symbology/qgssymbollayerutils.h
@@ -537,11 +537,10 @@ class CORE_EXPORT QgsSymbolLayerUtils
      * \param data mime data to parse
      * \param hasAlpha will be set to TRUE if mime data was interpreted as a color containing
      * an explicit alpha value
-     * \returns valid color if mimedata could be interpreted as a color, otherwise an
-     * invalid color
+     * \returns valid color if mimedata could be interpreted as a color, otherwise an invalid color
      * \since QGIS 2.5
      */
-    static QColor colorFromMimeData( const QMimeData *data, bool &hasAlpha );
+    static QColor colorFromMimeData( const QMimeData *data, bool &hasAlpha SIP_OUT );
 
     /**
      * Attempts to parse mime data as a list of named colors