Skip to content

Commit bdc47a4

Browse files
committedNov 20, 2017
Add missing doxymentation
1 parent 7fb3a4e commit bdc47a4

File tree

6 files changed

+24
-2
lines changed

6 files changed

+24
-2
lines changed
 

‎python/core/qgsaggregatecalculator.sip

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ class QgsAggregateCalculator
147147

148148
static QList< QgsAggregateCalculator::AggregateInfo > aggregates();
149149
%Docstring
150+
Structured information for available aggregates.
151+
152+
.. versionadded:: 3.2
150153
:rtype: list of QgsAggregateCalculator.AggregateInfo
151154
%End
152155

‎python/gui/qgsaggregatetoolbutton.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class QgsAggregateToolButton : QToolButton
7171

7272
void activeChanged();
7373
%Docstring
74-
A function has been selected or unselected.
74+
A function has been selected or deselected.
7575
%End
7676

7777
};

‎python/gui/qgsattributeformwidget.sip

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ class QgsAttributeFormWidget : QWidget /Abstract/
3333
};
3434

3535
explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
36+
%Docstring
37+
A new form widget for the wrapper ``widget`` on ``form``.
38+
%End
3639

3740
virtual void createSearchWidgetWrappers() = 0;
3841
%Docstring
@@ -96,6 +99,10 @@ class QgsAttributeFormWidget : QWidget /Abstract/
9699
%End
97100

98101
void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
102+
%Docstring
103+
Adds an additional search widget wrapper.
104+
Used to register a secondary search widget as used for "between" searches.
105+
%End
99106

100107
QList< QgsSearchWidgetWrapper * > searchWidgetWrappers();
101108
%Docstring

‎src/core/qgsaggregatecalculator.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,11 @@ class CORE_EXPORT QgsAggregateCalculator
167167
*/
168168
static Aggregate stringToAggregate( const QString &string, bool *ok = nullptr );
169169

170+
/**
171+
* Structured information for available aggregates.
172+
*
173+
* \since QGIS 3.2
174+
*/
170175
static QList< QgsAggregateCalculator::AggregateInfo > aggregates();
171176

172177
private:

‎src/gui/qgsaggregatetoolbutton.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class GUI_EXPORT QgsAggregateToolButton : public QToolButton
7979
void aggregateChanged();
8080

8181
/**
82-
* A function has been selected or unselected.
82+
* A function has been selected or deselected.
8383
*/
8484
void activeChanged();
8585

‎src/gui/qgsattributeformwidget.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
3636
AggregateSearchMode, //!< Embedded in a search form, show additional aggregate function toolbutton
3737
};
3838

39+
/**
40+
* A new form widget for the wrapper \a widget on \a form.
41+
*/
3942
explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
4043

4144
/**
@@ -98,6 +101,10 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
98101
*/
99102
void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
100103

104+
/**
105+
* Adds an additional search widget wrapper.
106+
* Used to register a secondary search widget as used for "between" searches.
107+
*/
101108
void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
102109

103110
/**

0 commit comments

Comments
 (0)
Please sign in to comment.