Fix non-compliant docstrings

qgis · May 23, 2018 · afa04d9 · afa04d9
1 parent 8b1bbfe
commit afa04d9
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git a/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
@@ -187,33 +187,34 @@ Add a hint text on the widget
 
     ConstraintResult constraintResult() const;
 %Docstring
-Getter of constraintResult
-It's the current result of the constraint on the widget influencing it's visualization.
+Returns the constraint result, which is the current result of the constraint
+on the widget influencing its visualization.
 
 .. versionadded:: 3.0
 %End
 
     bool constraintResultVisible() const;
 %Docstring
-Getter of constraintResultVisible
-Defines if the constraint result should be visualized on the widget (with color).
+Returns whether the constraint result is visible.
+
+Returns true if the constraint result will be visualized on the widget (with color).
 This will be disabled when the form is not editable.
 
 .. versionadded:: 3.0
 %End
 
     void setConstraintResultVisible( bool constraintResultVisible );
 %Docstring
-Setter of constraintResultVisible
-Defines if the constraint result should be visualized on the widget (with color).
+Sets whether the constraint result is visible.
+
+Controls if the constraint result should be visualized on the widget (with color).
 This will be disabled when the form is not editable.
 
 :param constraintResultVisible: if constraintResult should be displayed (mostly editable status)
 
 .. versionadded:: 3.0
 %End
 
-
   signals:
 
     void valueChanged( const QVariant &value );

diff --git a/python/gui/auto_generated/qgsattributetypeloaddialog.sip.in b/python/gui/auto_generated/qgsattributetypeloaddialog.sip.in
@@ -35,7 +35,7 @@ Sets predefined vector layer for selection of data
 
     QMap<QString, QVariant> &valueMap();
 %Docstring
-Getter to value map which is currently active
+Returns the value map which is currently active.
 
 :return: value map of vlues selected from layer
 %End

diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
@@ -190,30 +190,34 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
     virtual void setHint( const QString &hintText );
 
     /**
-     * Getter of constraintResult
-     * It's the current result of the constraint on the widget influencing it's visualization.
+     * Returns the constraint result, which is the current result of the constraint
+     * on the widget influencing its visualization.
+     *
      * \since QGIS 3.0
      */
     ConstraintResult constraintResult() const;
 
     /**
-     * Getter of constraintResultVisible
-     * Defines if the constraint result should be visualized on the widget (with color).
+     * Returns whether the constraint result is visible.
+     *
+     * Returns true if the constraint result will be visualized on the widget (with color).
      * This will be disabled when the form is not editable.
+     *
      * \since QGIS 3.0
      */
     bool constraintResultVisible() const;
 
     /**
-     * Setter of constraintResultVisible
-     * Defines if the constraint result should be visualized on the widget (with color).
+     * Sets whether the constraint result is visible.
+     *
+     * Controls if the constraint result should be visualized on the widget (with color).
      * This will be disabled when the form is not editable.
+     *
      * \param constraintResultVisible if constraintResult should be displayed (mostly editable status)
      * \since QGIS 3.0
      */
     void setConstraintResultVisible( bool constraintResultVisible );
 
-
   signals:
 
     /**

diff --git a/src/gui/qgsattributetypeloaddialog.h b/src/gui/qgsattributetypeloaddialog.h
@@ -52,7 +52,8 @@ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttr
     void setVectorLayer( QgsVectorLayer *layer );
 
     /**
-     * Getter to value map which is currently active
+     * Returns the value map which is currently active.
+     *
      * \returns value map of vlues selected from layer
      */
     QMap<QString, QVariant> &valueMap();