Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Remove some useless \returns dox
  • Loading branch information
nyalldawson committed May 27, 2018
1 parent 2a7b854 commit a804a33
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 50 deletions.
Expand Up @@ -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;
Expand Down
12 changes: 3 additions & 9 deletions src/gui/attributetable/qgsifeatureselectionmanager.h
Expand Up @@ -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;

Expand Down
32 changes: 0 additions & 32 deletions src/gui/attributetable/qgsvectorlayerselectionmanager.h
Expand Up @@ -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:
Expand Down

0 comments on commit a804a33

Please sign in to comment.