Skip to content

Commit

Permalink
improved api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
signedav committed Oct 26, 2017
1 parent 69f069a commit 3dbffb0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 13 deletions.
9 changes: 3 additions & 6 deletions python/core/qgsvectorlayerutils.sip
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class QgsVectorLayerUtils

QList<QgsVectorLayer *> layers() const;
%Docstring
Returns all the layers in the member QMap mDuplicatedFeatures
Returns all the layers on which features have been duplicated
.. versionadded:: 3.0
:rtype: list of QgsVectorLayer
%End
Expand Down Expand Up @@ -99,11 +99,8 @@ class QgsVectorLayerUtils
Duplicates a feature and it's children (one level deep). It calls CreateFeature, so
default values and constraints (e.g., unique constraints) will automatically be handled.
The duplicated feature will be automatically inserted into the layer.
\param layer
\param feature the active feature
\param project
\param depth the higher this number the deeper the level - With depth > 0 the children of the feature are not duplicated
\param duplicateFeatureContext stores all the layers and the featureids of the duplicated features (incl. children)
``depth`` the higher this number the deeper the level - With depth > 0 the children of the feature are not duplicated
``duplicateFeatureContext`` stores all the layers and the featureids of the duplicated features (incl. children)
.. versionadded:: 3.0
:rtype: QgsFeature
%End
Expand Down
11 changes: 4 additions & 7 deletions src/core/qgsvectorlayerutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class CORE_EXPORT QgsVectorLayerUtils
QgsDuplicateFeatureContext() {}

/**
* Returns all the layers in the member QMap mDuplicatedFeatures
* Returns all the layers on which features have been duplicated
* \since QGIS 3.0
*/
QList<QgsVectorLayer *> layers() const;
Expand All @@ -63,7 +63,7 @@ class CORE_EXPORT QgsVectorLayerUtils
friend class QgsVectorLayerUtils;

/**
* To set an entry to the member QMap mDuplicatedFeatures
* To set info about duplicated features to the function feedback (layout and ids)
* \since QGIS 3.0
*/
void setDuplicatedFeatures( QgsVectorLayer *layer, QgsFeatureIds ids );
Expand Down Expand Up @@ -109,11 +109,8 @@ class CORE_EXPORT QgsVectorLayerUtils
* Duplicates a feature and it's children (one level deep). It calls CreateFeature, so
* default values and constraints (e.g., unique constraints) will automatically be handled.
* The duplicated feature will be automatically inserted into the layer.
* \param layer
* \param feature the active feature
* \param project
* \param depth the higher this number the deeper the level - With depth > 0 the children of the feature are not duplicated
* \param duplicateFeatureContext stores all the layers and the featureids of the duplicated features (incl. children)
* \a depth the higher this number the deeper the level - With depth > 0 the children of the feature are not duplicated
* \a duplicateFeatureContext stores all the layers and the featureids of the duplicated features (incl. children)
* \since QGIS 3.0
*/
static QgsFeature duplicateFeature( QgsVectorLayer *layer, const QgsFeature &feature, QgsProject *project, int depth, QgsDuplicateFeatureContext &duplicateFeatureContext SIP_OUT );
Expand Down

0 comments on commit 3dbffb0

Please sign in to comment.