sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix non-compliant docstrings

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
View File

@ -187,16 +187,17 @@ 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
@ -204,8 +205,9 @@ This will be disabled when the form is not editable.
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)
@ -213,7 +215,6 @@ This will be disabled when the form is not editable.
.. versionadded:: 3.0
%End
signals:
void valueChanged( const QVariant &value );

2
python/gui/auto_generated/qgsattributetypeloaddialog.sip.in
View File

@ -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

18
src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
View File

@ -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:
/**

3
src/gui/qgsattributetypeloaddialog.h
View File

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