Add missing doxymentation

qgis · Nov 20, 2017 · bdc47a4 · bdc47a4
1 parent 7fb3a4e
commit bdc47a4
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 2 deletions.
diff --git a/python/core/qgsaggregatecalculator.sip b/python/core/qgsaggregatecalculator.sip
@@ -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
 

diff --git a/python/gui/qgsaggregatetoolbutton.sip b/python/gui/qgsaggregatetoolbutton.sip
@@ -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
 
 };

diff --git a/python/gui/qgsattributeformwidget.sip b/python/gui/qgsattributeformwidget.sip
@@ -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
@@ -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

diff --git a/src/core/qgsaggregatecalculator.h b/src/core/qgsaggregatecalculator.h
@@ -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:

diff --git a/src/gui/qgsaggregatetoolbutton.h b/src/gui/qgsaggregatetoolbutton.h
@@ -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();
 

diff --git a/src/gui/qgsattributeformwidget.h b/src/gui/qgsattributeformwidget.h
@@ -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 );
 
     /**
@@ -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 );
 
     /**