Skip to content
Permalink
Browse files

Fix non-compliant docstrings

  • Loading branch information
nyalldawson committed May 23, 2018
1 parent 8b1bbfe commit afa04d9b5b7e9bda177594e3dc7a4966afe234c3
@@ -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 );
@@ -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
@@ -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:

/**
@@ -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();

0 comments on commit afa04d9

Please sign in to comment.
You can’t perform that action at this time.