Fix non-compliant docstrings

This commit is contained in:
Nyall Dawson 2018-05-23 16:55:11 +10:00
parent 8b1bbfe8ae
commit afa04d9b5b
4 changed files with 22 additions and 16 deletions

View File

@ -187,16 +187,17 @@ Add a hint text on the widget
ConstraintResult constraintResult() const; ConstraintResult constraintResult() const;
%Docstring %Docstring
Getter of constraintResult Returns the constraint result, which is the current result of the constraint
It's the current result of the constraint on the widget influencing it's visualization. on the widget influencing its visualization.
.. versionadded:: 3.0 .. versionadded:: 3.0
%End %End
bool constraintResultVisible() const; bool constraintResultVisible() const;
%Docstring %Docstring
Getter of constraintResultVisible Returns whether the constraint result is visible.
Defines if the constraint result should be visualized on the widget (with color).
Returns true if the constraint result will be visualized on the widget (with color).
This will be disabled when the form is not editable. This will be disabled when the form is not editable.
.. versionadded:: 3.0 .. versionadded:: 3.0
@ -204,8 +205,9 @@ This will be disabled when the form is not editable.
void setConstraintResultVisible( bool constraintResultVisible ); void setConstraintResultVisible( bool constraintResultVisible );
%Docstring %Docstring
Setter of constraintResultVisible Sets whether the constraint result is visible.
Defines if the constraint result should be visualized on the widget (with color).
Controls if the constraint result should be visualized on the widget (with color).
This will be disabled when the form is not editable. This will be disabled when the form is not editable.
:param constraintResultVisible: if constraintResult should be displayed (mostly editable status) :param constraintResultVisible: if constraintResult should be displayed (mostly editable status)
@ -213,7 +215,6 @@ This will be disabled when the form is not editable.
.. versionadded:: 3.0 .. versionadded:: 3.0
%End %End
signals: signals:
void valueChanged( const QVariant &value ); void valueChanged( const QVariant &value );

View File

@ -35,7 +35,7 @@ Sets predefined vector layer for selection of data
QMap<QString, QVariant> &valueMap(); QMap<QString, QVariant> &valueMap();
%Docstring %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 :return: value map of vlues selected from layer
%End %End

View File

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

View File

@ -52,7 +52,8 @@ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttr
void setVectorLayer( QgsVectorLayer *layer ); 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 * \returns value map of vlues selected from layer
*/ */
QMap<QString, QVariant> &valueMap(); QMap<QString, QVariant> &valueMap();