Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add missing doxymentation
  • Loading branch information
m-kuhn committed Nov 20, 2017
1 parent 7fb3a4e commit bdc47a4
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 2 deletions.
3 changes: 3 additions & 0 deletions python/core/qgsaggregatecalculator.sip
Expand Up @@ -147,6 +147,9 @@ class QgsAggregateCalculator

static QList< QgsAggregateCalculator::AggregateInfo > aggregates();
%Docstring
Structured information for available aggregates.

.. versionadded:: 3.2
:rtype: list of QgsAggregateCalculator.AggregateInfo
%End

Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgsaggregatetoolbutton.sip
Expand Up @@ -71,7 +71,7 @@ class QgsAggregateToolButton : QToolButton

void activeChanged();
%Docstring
A function has been selected or unselected.
A function has been selected or deselected.
%End

};
Expand Down
7 changes: 7 additions & 0 deletions python/gui/qgsattributeformwidget.sip
Expand Up @@ -33,6 +33,9 @@ class QgsAttributeFormWidget : QWidget /Abstract/
};

explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
%Docstring
A new form widget for the wrapper ``widget`` on ``form``.
%End

virtual void createSearchWidgetWrappers() = 0;
%Docstring
Expand Down Expand Up @@ -96,6 +99,10 @@ class QgsAttributeFormWidget : QWidget /Abstract/
%End

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

QList< QgsSearchWidgetWrapper * > searchWidgetWrappers();
%Docstring
Expand Down
5 changes: 5 additions & 0 deletions src/core/qgsaggregatecalculator.h
Expand Up @@ -167,6 +167,11 @@ class CORE_EXPORT QgsAggregateCalculator
*/
static Aggregate stringToAggregate( const QString &string, bool *ok = nullptr );

/**
* Structured information for available aggregates.
*
* \since QGIS 3.2
*/
static QList< QgsAggregateCalculator::AggregateInfo > aggregates();

private:
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsaggregatetoolbutton.h
Expand Up @@ -79,7 +79,7 @@ class GUI_EXPORT QgsAggregateToolButton : public QToolButton
void aggregateChanged();

/**
* A function has been selected or unselected.
* A function has been selected or deselected.
*/
void activeChanged();

Expand Down
7 changes: 7 additions & 0 deletions src/gui/qgsattributeformwidget.h
Expand Up @@ -36,6 +36,9 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
AggregateSearchMode, //!< Embedded in a search form, show additional aggregate function toolbutton
};

/**
* A new form widget for the wrapper \a widget on \a form.
*/
explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );

/**
Expand Down Expand Up @@ -98,6 +101,10 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
*/
void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );

/**
* Adds an additional search widget wrapper.
* Used to register a secondary search widget as used for "between" searches.
*/
void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );

/**
Expand Down

0 comments on commit bdc47a4

Please sign in to comment.