Cleanup docs

This commit is contained in:
Nyall Dawson 2024-09-04 08:38:30 +10:00
parent a4723d7b97
commit 104ffa885a
3 changed files with 6 additions and 6 deletions

View File

@ -40,7 +40,7 @@ Deselect features by feature ``ids``.
virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0; virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0;
%Docstring %Docstring
Change selection to the new set of features. Dismisses the current selection. Change selection to the new set of features. Dismisses the current selection.
Will emit the selectionChanged( const :py:class:`QgsFeatureIds`&, const :py:class:`QgsFeatureIds`&, bool ) signal with the Will emit the :py:func:`~QgsIFeatureSelectionManager.selectionChanged` signal with the
clearAndSelect flag set. clearAndSelect flag set.
:param ids: The ids which will be the new selection :param ids: The ids which will be the new selection
@ -52,7 +52,7 @@ clearAndSelect flag set.
%Docstring %Docstring
Returns reference to identifiers of selected features Returns reference to identifiers of selected features
:return: A list of :py:class:`QgsFeatureId`'s :return: A list of selected :py:class:`QgsFeatureId`
.. seealso:: :py:func:`setSelectedFeatures` .. seealso:: :py:func:`setSelectedFeatures`
%End %End

View File

@ -40,7 +40,7 @@ Deselect features by feature ``ids``.
virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0; virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0;
%Docstring %Docstring
Change selection to the new set of features. Dismisses the current selection. Change selection to the new set of features. Dismisses the current selection.
Will emit the selectionChanged( const :py:class:`QgsFeatureIds`&, const :py:class:`QgsFeatureIds`&, bool ) signal with the Will emit the :py:func:`~QgsIFeatureSelectionManager.selectionChanged` signal with the
clearAndSelect flag set. clearAndSelect flag set.
:param ids: The ids which will be the new selection :param ids: The ids which will be the new selection
@ -52,7 +52,7 @@ clearAndSelect flag set.
%Docstring %Docstring
Returns reference to identifiers of selected features Returns reference to identifiers of selected features
:return: A list of :py:class:`QgsFeatureId`'s :return: A list of selected :py:class:`QgsFeatureId`
.. seealso:: :py:func:`setSelectedFeatures` .. seealso:: :py:func:`setSelectedFeatures`
%End %End

View File

@ -53,7 +53,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
/** /**
* Change selection to the new set of features. Dismisses the current selection. * Change selection to the new set of features. Dismisses the current selection.
* Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) signal with the * Will emit the selectionChanged() signal with the
* clearAndSelect flag set. * clearAndSelect flag set.
* *
* \param ids The ids which will be the new selection * \param ids The ids which will be the new selection
@ -64,7 +64,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
/** /**
* Returns reference to identifiers of selected features * Returns reference to identifiers of selected features
* *
* \returns A list of QgsFeatureId's * \returns A list of selected QgsFeatureId
* \see setSelectedFeatures() * \see setSelectedFeatures()
*/ */
virtual const QgsFeatureIds &selectedFeatureIds() const = 0; virtual const QgsFeatureIds &selectedFeatureIds() const = 0;