Skip to content

Commit c604d2d

Browse files
committed
run sipify
1 parent 8db419c commit c604d2d

File tree

717 files changed

+2479
-16712
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

717 files changed

+2479
-16712
lines changed

python/analysis/interpolation/qgsgridfilewriter.sip

-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ Writes the grid file.
3434
An optional ``feedback`` object can be set for progress reports and cancelation support
3535

3636
:return: 0 in case of success
37-
:rtype: int
38-
3937
%End
4038

4139
};

python/analysis/interpolation/qgsidwinterpolator.sip

-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ The default is a coefficient of 2.
4848

4949
Point values are weighted by 1 / ( distance ^ coefficient ).
5050

51-
:rtype: float
52-
5351
.. seealso:: :py:func:`setDistanceCoefficient()`
5452

5553
.. versionadded:: 3.0

python/analysis/interpolation/qgsinterpolator.sip

+1-4
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,13 @@ Source type
100100
virtual int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback = 0 ) = 0;
101101
%Docstring
102102
Calculates interpolation value for map coordinates x, y
103+
103104
:param x: x-coordinate (in map units)
104105
:param y: y-coordinate (in map units)
105106
:param result: out: interpolation result
106107
:param feedback: optional feedback object for progress and cancelation support
107108

108109
:return: 0 in case of success*
109-
:rtype: int
110-
111110
%End
112111

113112

@@ -122,8 +121,6 @@ An optional ``feedback`` argument may be specified to allow cancelation and
122121
progress reports from the cache operation.
123122

124123
:return: Success in case of success
125-
:rtype: Result
126-
127124
%End
128125

129126

python/analysis/interpolation/qgstininterpolator.sip

-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ Returns the fields output by features when saving the triangulation.
4646
These fields should be used when creating
4747
a suitable feature sink for setTriangulationSink()
4848

49-
:rtype: QgsFields
50-
5149
.. seealso:: :py:func:`setTriangulationSink()`
5250

5351
.. versionadded:: 3.0

python/analysis/network/qgsgraph.sip

+1-28
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,26 @@ Constructor for QgsGraphEdge.
3232
QVariant cost( int strategyIndex ) const;
3333
%Docstring
3434
Returns edge cost calculated using specified strategy
35-
:param strategyIndex: strategy index
3635

37-
:rtype: QVariant
36+
:param strategyIndex: strategy index
3837
%End
3938

4039
QVector< QVariant > strategies() const;
4140
%Docstring
4241
Returns array of available strategies
43-
44-
:rtype: list of QVariant
4542
%End
4643

4744
int toVertex() const;
4845
%Docstring
4946
Returns the index of the vertex at the end of this edge.
5047

51-
:rtype: int
52-
5348
.. seealso:: :py:func:`fromVertex()`
5449
%End
5550

5651
int fromVertex() const;
5752
%Docstring
5853
Returns the index of the vertex at the start of this edge.
5954

60-
:rtype: int
61-
6255
.. seealso:: :py:func:`toVertex()`
6356
%End
6457

@@ -95,25 +88,19 @@ This constructor initializes QgsGraphVertex object and associates a vertex with
9588
%Docstring
9689
Returns the incoming edge ids, i.e. edges which end at this node.
9790

98-
:rtype: QgsGraphEdgeIds
99-
10091
.. seealso:: :py:func:`outgoingEdges()`
10192
%End
10293

10394
QgsGraphEdgeIds outgoingEdges() const;
10495
%Docstring
10596
Returns outgoing edge ids, i.e. edges which start at this node.
10697

107-
:rtype: QgsGraphEdgeIds
108-
10998
.. seealso:: :py:func:`incomingEdges()`
11099
%End
111100

112101
QgsPointXY point() const;
113102
%Docstring
114103
Returns point associated with graph vertex.
115-
116-
:rtype: QgsPointXY
117104
%End
118105

119106
};
@@ -141,53 +128,39 @@ Constructor for QgsGraph.
141128
int addVertex( const QgsPointXY &pt );
142129
%Docstring
143130
Add a vertex to the graph
144-
145-
:rtype: int
146131
%End
147132

148133
int addEdge( int fromVertexIdx, int toVertexIdx, const QVector< QVariant > &strategies );
149134
%Docstring
150135
Add an edge to the graph, going from the ``fromVertexIdx``
151136
to ``toVertexIdx``.
152-
153-
:rtype: int
154137
%End
155138

156139
int vertexCount() const;
157140
%Docstring
158141
Returns number of graph vertices
159-
160-
:rtype: int
161142
%End
162143

163144
const QgsGraphVertex &vertex( int idx ) const;
164145
%Docstring
165146
Returns vertex at given index
166-
167-
:rtype: QgsGraphVertex
168147
%End
169148

170149
int edgeCount() const;
171150
%Docstring
172151
Returns number of graph edges
173-
174-
:rtype: int
175152
%End
176153

177154
const QgsGraphEdge &edge( int idx ) const;
178155
%Docstring
179156
Returns edge at given index
180-
181-
:rtype: QgsGraphEdge
182157
%End
183158

184159
int findVertex( const QgsPointXY &pt ) const;
185160
%Docstring
186161
Find vertex by associated point
187162

188163
:return: vertex index
189-
:rtype: int
190-
191164
%End
192165

193166
};

python/analysis/network/qgsgraphanalyzer.sip

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ points using different strategies with Dijkstra algorithm
2626
static SIP_PYLIST dijkstra( const QgsGraph *source, int startVertexIdx, int criterionNum, QVector<int> *resultTree = 0, QVector<double> *resultCost = 0 );
2727
%Docstring
2828
Solve shortest path problem using Dijkstra algorithm
29+
2930
:param source: source graph
3031
:param startVertexIdx: index of the start vertex
3132
:param criterionNum: index of the optimization strategy
@@ -65,11 +66,10 @@ Solve shortest path problem using Dijkstra algorithm
6566
static QgsGraph *shortestTree( const QgsGraph *source, int startVertexIdx, int criterionNum );
6667
%Docstring
6768
Returns shortest path tree with root-node in startVertexIdx
69+
6870
:param source: source graph
6971
:param startVertexIdx: index of the start vertex
7072
:param criterionNum: index of the optimization strategy
71-
72-
:rtype: QgsGraph
7373
%End
7474
};
7575

python/analysis/network/qgsgraphbuilder.sip

-2
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ MANDATORY BUILDER PROPERTY DECLARATION
4141
QgsGraph *graph() /Factory/;
4242
%Docstring
4343
Returns generated QgsGraph
44-
45-
:rtype: QgsGraph
4644
%End
4745

4846
};

python/analysis/network/qgsgraphbuilderinterface.sip

+3-8
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ QgsGraphBuilder and QgsGraphDirector both use a "builder" design pattern
3434
QgsGraphBuilderInterface( const QgsCoordinateReferenceSystem &crs, bool ctfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" );
3535
%Docstring
3636
Default constructor
37+
3738
:param crs: Coordinate reference system for new graph vertex
3839
:param ctfEnabled: enable coordinate transform from source graph CRS to CRS graph
3940
:param topologyTolerance: sqrt distance between source point as one graph vertex
@@ -45,34 +46,27 @@ Default constructor
4546
QgsCoordinateReferenceSystem destinationCrs() const;
4647
%Docstring
4748
Returns destinaltion CRS
48-
49-
:rtype: QgsCoordinateReferenceSystem
5049
%End
5150

5251
bool coordinateTransformationEnabled();
5352
%Docstring
5453
Returns coordinate transformation enabled
55-
56-
:rtype: bool
5754
%End
5855

5956
double topologyTolerance();
6057
%Docstring
6158
Returns topology tolerance
62-
63-
:rtype: float
6459
%End
6560

6661
QgsDistanceArea *distanceArea();
6762
%Docstring
6863
Returns measurement tool
69-
70-
:rtype: QgsDistanceArea
7164
%End
7265

7366
virtual void addVertex( int id, const QgsPointXY &pt );
7467
%Docstring
7568
Add vertex to the graph
69+
7670
:param id: vertex identifier
7771
:param pt: vertex coordinates
7872

@@ -84,6 +78,7 @@ Add vertex to the graph
8478
virtual void addEdge( int pt1id, const QgsPointXY &pt1, int pt2id, const QgsPointXY &pt2, const QVector< QVariant > &strategies );
8579
%Docstring
8680
Add edge to the graph
81+
8782
:param pt1id: first vertex identificator
8883
:param pt1: first vertex coordinates
8984
:param pt2id: second vertex identificator

python/analysis/network/qgsgraphdirector.sip

-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@ Add optimization strategy
5757
virtual QString name() const = 0;
5858
%Docstring
5959
Returns director name
60-
61-
:rtype: str
6260
%End
6361

6462
protected:

python/analysis/network/qgsnetworkstrategy.sip

-4
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,11 @@ Default constructor
5050
%Docstring
5151
Returns a list of the source layer attributes needed for cost calculation.
5252
This is method called by QgsGraphDirector.
53-
54-
:rtype: set of int
5553
%End
5654

5755
virtual QVariant cost( double distance, const QgsFeature &f ) const = 0;
5856
%Docstring
5957
Returns edge cost
60-
61-
:rtype: QVariant
6258
%End
6359
};
6460

python/analysis/network/qgsvectorlayerdirector.sip

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ class QgsVectorLayerDirector : QgsGraphDirector
3939
);
4040
%Docstring
4141
Default constructor
42+
4243
:param source: feature source representing network
4344
:param directionFieldId: field containing direction value
4445
:param directDirectionValue: value for direct one-way road

0 commit comments

Comments
 (0)