Remove some useless \returns dox

This commit is contained in:
Nyall Dawson 2018-05-28 09:48:16 +10:00
parent 2a7b854e25
commit a804a33bc7
3 changed files with 6 additions and 50 deletions

View File

@ -25,23 +25,17 @@ e.g. QgsVectorLayer implements this interface to manage its selections.
QgsIFeatureSelectionManager( QObject *parent /TransferThis/ );
virtual int selectedFeatureCount() = 0;
%Docstring
The number of features that are selected in this layer
:return: See description
Returns the number of features that are selected in this layer.
%End
virtual void select( const QgsFeatureIds &ids ) = 0;
%Docstring
Select features
:param ids: Feature ids to select
Select features by feature ``ids``.
%End
virtual void deselect( const QgsFeatureIds &ids ) = 0;
%Docstring
Deselect features
:param ids: Feature ids to deselect
Deselect features by feature ``ids``.
%End
virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0;

View File

@ -38,23 +38,17 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
: QObject( parent ) {}
/**
* The number of features that are selected in this layer
*
* \returns See description
* Returns the number of features that are selected in this layer.
*/
virtual int selectedFeatureCount() = 0;
/**
* Select features
*
* \param ids Feature ids to select
* Select features by feature \a ids.
*/
virtual void select( const QgsFeatureIds &ids ) = 0;
/**
* Deselect features
*
* \param ids Feature ids to deselect
* Deselect features by feature \a ids.
*/
virtual void deselect( const QgsFeatureIds &ids ) = 0;

View File

@ -36,42 +36,10 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan
public:
explicit QgsVectorLayerSelectionManager( QgsVectorLayer *layer, QObject *parent = nullptr );
/**
* The number of features that are selected in this layer
*
* \returns See description
*/
int selectedFeatureCount() override;
/**
* Select features
*
* \param ids Feature ids to select
*/
void select( const QgsFeatureIds &ids ) override;
/**
* Deselect features
*
* \param ids Feature ids to deselect
*/
void deselect( const QgsFeatureIds &ids ) override;
/**
* Change selection to the new set of features. Dismisses the current selection.
* Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) signal with the
* clearAndSelect flag set.
*
* \param ids The ids which will be the new selection
*/
void setSelectedFeatures( const QgsFeatureIds &ids ) override;
/**
* Returns reference to identifiers of selected features
*
* \returns A list of QgsFeatureIds
* \see selectedFeatures()
*/
const QgsFeatureIds &selectedFeatureIds() const override;
private: