Some doxygen grammar fixes

qgis · Oct 20, 2020 · 5565a68 · 5565a68
1 parent d3adc10
commit 5565a68
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 17 deletions.
diff --git a/python/core/auto_generated/qgscacheindex.sip.in b/python/core/auto_generated/qgscacheindex.sip.in
@@ -29,7 +29,7 @@ Constructor for QgsAbstractCacheIndex.
 
     virtual void flushFeature( QgsFeatureId fid ) = 0;
 %Docstring
-Is called, whenever a feature is removed from the cache. You should update your indexes, so
+Is called whenever a feature is removed from the cache. You should update your indexes so
 they become invalid in case this feature was required to successfully answer a request.
 %End
 
@@ -51,7 +51,8 @@ Does nothing by default
 
     virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0;
 %Docstring
-Is called, when a feature request is issued on a cached layer.
+Is called when a feature request is issued on a cached layer.
+
 If this cache index is able to completely answer the feature request, it will return ``True``
 and set the iterator to a valid iterator over the cached features. If it is not able
 it will return ``False``.

diff --git a/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
@@ -291,7 +291,7 @@ Is forwarded to the slot :py:func:`~QgsEditorWidgetWrapper.setValues`
 
     virtual void setValue( const QVariant &value ) /Deprecated/;
 %Docstring
-Is called, when the value of the widget needs to be changed. Update the widget representation
+Is called when the value of the widget needs to be changed. Updates the widget representation
 to reflect the new value.
 
 :param value: The new value of the attribute
@@ -302,8 +302,8 @@ to reflect the new value.
 
     void setValues( const QVariant &value, const QVariantList &additionalValues );
 %Docstring
-Is called, when the value of the widget or additional field values
-needs to be changed. Update the widget representation
+Is called when the value of the widget or additional field values
+needs to be changed. Updates the widget representation
 to reflect the new values.
 
 .. versionadded:: 3.10

diff --git a/python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in
@@ -211,7 +211,7 @@ This method should initialize the editor widget with runtime data. Fill your com
 
     virtual void setFeature( const QgsFeature &feature ) = 0;
 %Docstring
-Is called, when the value of the widget needs to be changed. Update the widget representation
+Is called when the value of the widget needs to be changed. Updates the widget representation
 to reflect the new value.
 
 :param feature: The new feature

diff --git a/python/gui/auto_generated/qgisinterface.sip.in b/python/gui/auto_generated/qgisinterface.sip.in
@@ -1526,7 +1526,7 @@ Emitted when a project file is successfully read.
 .. note::
 
    This is useful for plugins that store properties with project files.
-   A plugin can connect to this signal. When it is emitted, the plugin
+   A plugin can connect to this signal. When it is emitted the plugin
    knows to then check the project properties for any relevant state.
 %End
 

diff --git a/src/core/qgscacheindex.h b/src/core/qgscacheindex.h
@@ -39,7 +39,7 @@ class CORE_EXPORT QgsAbstractCacheIndex
     virtual ~QgsAbstractCacheIndex() = default;
 
     /**
-     * Is called, whenever a feature is removed from the cache. You should update your indexes, so
+     * Is called whenever a feature is removed from the cache. You should update your indexes so
      * they become invalid in case this feature was required to successfully answer a request.
      */
     virtual void flushFeature( QgsFeatureId fid ) = 0;
@@ -62,7 +62,8 @@ class CORE_EXPORT QgsAbstractCacheIndex
     virtual void requestCompleted( const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids );
 
     /**
-     * Is called, when a feature request is issued on a cached layer.
+     * Is called when a feature request is issued on a cached layer.
+     *
      * If this cache index is able to completely answer the feature request, it will return TRUE
      * and set the iterator to a valid iterator over the cached features. If it is not able
      * it will return FALSE.

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -2392,7 +2392,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
      *   to do in order to be able to save the changes.
      * - to set the property back to TRUE, once the user has fixed his data.
      *
-     * When calling \see commitChanges(), this flag is checked just after the
+     * When calling \see commitChanges() this flag is checked just after the
      * \see beforeCommitChanges() signal is emitted, so it's possible to adjust it from there.
      *
      * \note Not available in Python bindings
@@ -2411,7 +2411,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
      *   to do in order to be able to save the changes.
      * - to set the property back to TRUE, once the user has fixed his data.
      *
-     * When calling \see commitChanges(), this flag is checked just after the
+     * When calling \see commitChanges() this flag is checked just after the
      * \see beforeCommitChanges() signal is emitted, so it's possible to adjust it from there.
      *
      * \note Not available in Python bindings

diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
@@ -286,7 +286,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
     // TODO Q_DECL_DEPRECATED
 
     /**
-     * Is called, when the value of the widget needs to be changed. Update the widget representation
+     * Is called when the value of the widget needs to be changed. Updates the widget representation
      * to reflect the new value.
      *
      * \param value The new value of the attribute
@@ -295,8 +295,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
     virtual void setValue( const QVariant &value ) SIP_DEPRECATED;
 
     /**
-     * Is called, when the value of the widget or additional field values
-     * needs to be changed. Update the widget representation
+     * Is called when the value of the widget or additional field values
+     * needs to be changed. Updates the widget representation
      * to reflect the new values.
      * \since QGIS 3.10
      */
@@ -364,7 +364,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
   private:
 
     /**
-    * Is called, when the value of the widget needs to be changed. Update the widget representation
+    * Is called when the value of the widget needs to be changed. Updates the widget representation
     * to reflect the new value.
     *
     * \param value The new value of the attribute

diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h
@@ -247,7 +247,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
   public slots:
 
     /**
-     * Is called, when the value of the widget needs to be changed. Update the widget representation
+     * Is called when the value of the widget needs to be changed. Updates the widget representation
      * to reflect the new value.
      *
      * \param feature The new feature

diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -1260,7 +1260,7 @@ class GUI_EXPORT QgisInterface : public QObject
     /**
      * Emitted when a project file is successfully read.
      * \note This is useful for plugins that store properties with project files.
-     *       A plugin can connect to this signal. When it is emitted, the plugin
+     *       A plugin can connect to this signal. When it is emitted the plugin
      *       knows to then check the project properties for any relevant state.
      */
     void projectRead();