Add missing doxymentation

This commit is contained in:
Matthias Kuhn 2017-11-02 18:06:14 +01:00
parent 7fb3a4eb66
commit bdc47a48d9
6 changed files with 24 additions and 2 deletions

View File

@ -147,6 +147,9 @@ class QgsAggregateCalculator
static QList< QgsAggregateCalculator::AggregateInfo > aggregates(); static QList< QgsAggregateCalculator::AggregateInfo > aggregates();
%Docstring %Docstring
Structured information for available aggregates.
.. versionadded:: 3.2
:rtype: list of QgsAggregateCalculator.AggregateInfo :rtype: list of QgsAggregateCalculator.AggregateInfo
%End %End

View File

@ -71,7 +71,7 @@ class QgsAggregateToolButton : QToolButton
void activeChanged(); void activeChanged();
%Docstring %Docstring
A function has been selected or unselected. A function has been selected or deselected.
%End %End
}; };

View File

@ -33,6 +33,9 @@ class QgsAttributeFormWidget : QWidget /Abstract/
}; };
explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form ); explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
%Docstring
A new form widget for the wrapper ``widget`` on ``form``.
%End
virtual void createSearchWidgetWrappers() = 0; virtual void createSearchWidgetWrappers() = 0;
%Docstring %Docstring
@ -96,6 +99,10 @@ class QgsAttributeFormWidget : QWidget /Abstract/
%End %End
void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper ); 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(); QList< QgsSearchWidgetWrapper * > searchWidgetWrappers();
%Docstring %Docstring

View File

@ -167,6 +167,11 @@ class CORE_EXPORT QgsAggregateCalculator
*/ */
static Aggregate stringToAggregate( const QString &string, bool *ok = nullptr ); static Aggregate stringToAggregate( const QString &string, bool *ok = nullptr );
/**
* Structured information for available aggregates.
*
* \since QGIS 3.2
*/
static QList< QgsAggregateCalculator::AggregateInfo > aggregates(); static QList< QgsAggregateCalculator::AggregateInfo > aggregates();
private: private:

View File

@ -79,7 +79,7 @@ class GUI_EXPORT QgsAggregateToolButton : public QToolButton
void aggregateChanged(); void aggregateChanged();
/** /**
* A function has been selected or unselected. * A function has been selected or deselected.
*/ */
void activeChanged(); void activeChanged();

View File

@ -36,6 +36,9 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
AggregateSearchMode, //!< Embedded in a search form, show additional aggregate function toolbutton 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 ); explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
/** /**
@ -98,6 +101,10 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
*/ */
void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper ); 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 ); void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
/** /**