sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-17 00:09:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

Some doxygen grammar fixes

Browse Source
This commit is contained in:
Nyall Dawson 2020-10-21 06:38:42 +10:00
parent d3adc10ec3
commit 5565a6858d
9 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
python/core/auto_generated/qgscacheindex.sip.in
View File

@ -29,7 +29,7 @@ Constructor for QgsAbstractCacheIndex.
virtual void flushFeature( QgsFeatureId fid ) = 0; virtual void flushFeature( QgsFeatureId fid ) = 0;
%Docstring %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. they become invalid in case this feature was required to successfully answer a request.
%End %End
@ -51,7 +51,8 @@ Does nothing by default
virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0; virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0;
%Docstring %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`` 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 and set the iterator to a valid iterator over the cached features. If it is not able
it will return ``False``. it will return ``False``.

6
python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
View File

@ -291,7 +291,7 @@ Is forwarded to the slot :py:func:`~QgsEditorWidgetWrapper.setValues`
virtual void setValue( const QVariant &value ) /Deprecated/; virtual void setValue( const QVariant &value ) /Deprecated/;
%Docstring %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. to reflect the new value.
:param value: The new value of the attribute :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 ); void setValues( const QVariant &value, const QVariantList &additionalValues );
%Docstring %Docstring
Is called, when the value of the widget or additional field values Is called when the value of the widget or additional field values
needs to be changed. Update the widget representation needs to be changed. Updates the widget representation
to reflect the new values. to reflect the new values.
.. versionadded:: 3.10 .. versionadded:: 3.10

2
python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in
View File

@ -211,7 +211,7 @@ This method should initialize the editor widget with runtime data. Fill your com
virtual void setFeature( const QgsFeature &feature ) = 0; virtual void setFeature( const QgsFeature &feature ) = 0;
%Docstring %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. to reflect the new value.
:param feature: The new feature :param feature: The new feature

2
python/gui/auto_generated/qgisinterface.sip.in
View File

@ -1526,7 +1526,7 @@ Emitted when a project file is successfully read.
.. note:: .. note::
This is useful for plugins that store properties with project files. 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. knows to then check the project properties for any relevant state.
%End %End

5
src/core/qgscacheindex.h
View File

@ -39,7 +39,7 @@ class CORE_EXPORT QgsAbstractCacheIndex
virtual ~QgsAbstractCacheIndex() = default; 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. * they become invalid in case this feature was required to successfully answer a request.
*/ */
virtual void flushFeature( QgsFeatureId fid ) = 0; virtual void flushFeature( QgsFeatureId fid ) = 0;
@ -62,7 +62,8 @@ class CORE_EXPORT QgsAbstractCacheIndex
virtual void requestCompleted( const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids ); 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 * 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 * and set the iterator to a valid iterator over the cached features. If it is not able
* it will return FALSE. * it will return FALSE.

4
src/core/qgsvectorlayer.h
View File

@ -2392,7 +2392,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
* to do in order to be able to save the changes. * 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. * - 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. * \see beforeCommitChanges() signal is emitted, so it's possible to adjust it from there.
* *
* \note Not available in Python bindings * \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 do in order to be able to save the changes.
* - to set the property back to TRUE, once the user has fixed his data. * - 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. * \see beforeCommitChanges() signal is emitted, so it's possible to adjust it from there.
* *
* \note Not available in Python bindings * \note Not available in Python bindings

8
src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
View File

@ -286,7 +286,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
// TODO Q_DECL_DEPRECATED // 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. * to reflect the new value.
* *
* \param value The new value of the attribute * \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; virtual void setValue( const QVariant &value ) SIP_DEPRECATED;
/** /**
* Is called, when the value of the widget or additional field values * Is called when the value of the widget or additional field values
* needs to be changed. Update the widget representation * needs to be changed. Updates the widget representation
* to reflect the new values. * to reflect the new values.
* \since QGIS 3.10 * \since QGIS 3.10
*/ */
@ -364,7 +364,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
private: 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. * to reflect the new value.
* *
* \param value The new value of the attribute * \param value The new value of the attribute

2
src/gui/editorwidgets/core/qgswidgetwrapper.h
View File

@ -247,7 +247,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
public slots: 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. * to reflect the new value.
* *
* \param feature The new feature * \param feature The new feature

2
src/gui/qgisinterface.h
View File

@ -1260,7 +1260,7 @@ class GUI_EXPORT QgisInterface : public QObject
/** /**
* Emitted when a project file is successfully read. * Emitted when a project file is successfully read.
* \note This is useful for plugins that store properties with project files. * \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. * knows to then check the project properties for any relevant state.
*/ */
void projectRead(); void projectRead();