Add doxymentation

qgis · Nov 1, 2017 · 5d2c39b · 5d2c39b
1 parent e0c1f0b
commit 5d2c39b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/python/gui/editorwidgets/core/qgssearchwidgetwrapper.sip b/python/gui/editorwidgets/core/qgssearchwidgetwrapper.sip
@@ -206,7 +206,11 @@ class QgsSearchWidgetWrapper : QgsWidgetWrapper
 
   protected slots:
 
-    virtual void setExpression( const QString &value ) = 0;
+    virtual void setExpression( const QString &expression ) = 0;
+%Docstring
+ Set the ``expression`` which is currently used as filter for this widget.
+%End
+
     virtual void setFeature( const QgsFeature &feature );
 
 

diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h
@@ -225,7 +225,11 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper
 
   protected slots:
 
-    virtual void setExpression( const QString &value ) = 0;
+    /**
+     * Set the \a expression which is currently used as filter for this widget.
+     */
+    virtual void setExpression( const QString &expression ) = 0;
+
     void setFeature( const QgsFeature &feature ) override;
 
   protected: