Skip to content

Commit a70bfe6

Browse files
m-kuhnm-kuhn
committedAug 14, 2017
More doxymentation
1 parent 8294c43 commit a70bfe6

File tree

2 files changed

+38
-30
lines changed

2 files changed

+38
-30
lines changed
 

‎python/core/qgsvectorlayereditutils.sip

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,32 @@ class QgsVectorLayerEditUtils
2121
bool insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex );
2222
%Docstring
2323
Insert a new vertex before the given vertex number,
24-
in the given ring, item (first number is index 0), and feature
25-
Not meaningful for Point geometries
24+
in the given ring, item (first number is index 0), and feature
25+
Not meaningful for Point geometries
2626
:rtype: bool
2727
%End
2828

2929
bool insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex );
3030
%Docstring
31-
Insert a new vertex before the given vertex number,
32-
in the given ring, item (first number is index 0), and feature
33-
Not meaningful for Point geometries
31+
Inserts a new vertex before the given vertex number,
32+
in the given ring, item (first number is index 0), and feature
33+
Not meaningful for Point geometries
3434
:rtype: bool
3535
%End
3636

3737
bool moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex );
3838
%Docstring
3939
Moves the vertex at the given position number,
40-
ring and item (first number is index 0), and feature
41-
to the given coordinates
40+
ring and item (first number is index 0), and feature
41+
to the given coordinates
4242
:rtype: bool
4343
%End
4444

4545
bool moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex ) /PyName=moveVertexV2/;
4646
%Docstring
4747
Moves the vertex at the given position number,
48-
ring and item (first number is index 0), and feature
49-
to the given coordinates
48+
ring and item (first number is index 0), and feature
49+
to the given coordinates
5050
.. note::
5151

5252
available in Python bindings as moveVertexV2
@@ -117,7 +117,7 @@ class QgsVectorLayerEditUtils
117117

118118
QgsGeometry::OperationResult addPart( QgsCurve *ring, QgsFeatureId featureId ) /PyName=addCurvedPart/;
119119
%Docstring
120-
Add a new part polygon to a multipart feature
120+
Adds a new part polygon to a multipart feature
121121

122122
:return:
123123
- QgsGeometry.Success
@@ -144,7 +144,7 @@ class QgsVectorLayerEditUtils
144144

145145
QgsGeometry::OperationResult splitParts( const QList<QgsPointXY> &splitLine, bool topologicalEditing = false );
146146
%Docstring
147-
Split parts cut by the given line
147+
Splits parts cut by the given line
148148
\param splitLine line that splits the layer feature parts
149149
\param topologicalEditing true if topological editing is enabled
150150
:return:

‎src/core/qgsvectorlayereditutils.h

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,45 @@ class CORE_EXPORT QgsVectorLayerEditUtils
3232
public:
3333
QgsVectorLayerEditUtils( QgsVectorLayer *layer );
3434

35-
/** Insert a new vertex before the given vertex number,
36-
* in the given ring, item (first number is index 0), and feature
37-
* Not meaningful for Point geometries
35+
/**
36+
* Insert a new vertex before the given vertex number,
37+
* in the given ring, item (first number is index 0), and feature
38+
* Not meaningful for Point geometries
3839
*/
3940
bool insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex );
4041

41-
/** Insert a new vertex before the given vertex number,
42-
* in the given ring, item (first number is index 0), and feature
43-
* Not meaningful for Point geometries
42+
/**
43+
* Inserts a new vertex before the given vertex number,
44+
* in the given ring, item (first number is index 0), and feature
45+
* Not meaningful for Point geometries
4446
*/
4547
bool insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex );
4648

47-
/** Moves the vertex at the given position number,
48-
* ring and item (first number is index 0), and feature
49-
* to the given coordinates
49+
/**
50+
* Moves the vertex at the given position number,
51+
* ring and item (first number is index 0), and feature
52+
* to the given coordinates
5053
*/
5154
bool moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex );
5255

53-
/** Moves the vertex at the given position number,
54-
* ring and item (first number is index 0), and feature
55-
* to the given coordinates
56-
* \note available in Python bindings as moveVertexV2
56+
/**
57+
* Moves the vertex at the given position number,
58+
* ring and item (first number is index 0), and feature
59+
* to the given coordinates
60+
* \note available in Python bindings as moveVertexV2
5761
*/
5862
bool moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex ) SIP_PYNAME( moveVertexV2 );
5963

60-
/** Deletes a vertex from a feature.
64+
/**
65+
* Deletes a vertex from a feature.
6166
* \param featureId ID of feature to remove vertex from
6267
* \param vertex index of vertex to delete
6368
* \since QGIS 2.14
6469
*/
6570
QgsVectorLayer::EditResult deleteVertex( QgsFeatureId featureId, int vertex );
6671

67-
/** Adds a ring to polygon/multipolygon features
72+
/**
73+
* Adds a ring to polygon/multipolygon features
6874
* \param ring ring to add
6975
* \param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise
7076
* all intersecting features are tested and the ring is added to the first valid feature.
@@ -109,7 +115,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils
109115
QgsGeometry::OperationResult addPart( const QgsPointSequence &ring, QgsFeatureId featureId );
110116

111117
/**
112-
* Add a new part polygon to a multipart feature
118+
* Adds a new part polygon to a multipart feature
113119
*
114120
* \return
115121
* - QgsGeometry::Success
@@ -132,7 +138,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils
132138
int translateFeature( QgsFeatureId featureId, double dx, double dy );
133139

134140
/**
135-
* Split parts cut by the given line
141+
* Splits parts cut by the given line
136142
* \param splitLine line that splits the layer feature parts
137143
* \param topologicalEditing true if topological editing is enabled
138144
* \return
@@ -156,14 +162,16 @@ class CORE_EXPORT QgsVectorLayerEditUtils
156162
*/
157163
QgsGeometry::OperationResult splitFeatures( const QList<QgsPointXY> &splitLine, bool topologicalEditing = false );
158164

159-
/** Adds topological points for every vertex of the geometry.
165+
/**
166+
* Adds topological points for every vertex of the geometry.
160167
* \param geom the geometry where each vertex is added to segments of other features
161168
* \note geom is not going to be modified by the function
162169
* \returns 0 in case of success
163170
*/
164171
int addTopologicalPoints( const QgsGeometry &geom );
165172

166-
/** Adds a vertex to segments which intersect point p but don't
173+
/**
174+
* Adds a vertex to segments which intersect point p but don't
167175
* already have a vertex there. If a feature already has a vertex at position p,
168176
* no additional vertex is inserted. This method is useful for topological
169177
* editing.

0 commit comments

Comments
 (0)