Skip to content

Commit 0e7427f

Browse files
3nids3nids
authoredDec 19, 2018
Merge pull request #8711 from 3nids/sipify_out_super
 [sipify] enhanced SIP_OUT handling
·
ltr-3_40final-3_6_0
2 parents a753f8b + 166e952 commit 0e7427f

29 files changed

+144
-114
lines changed
 

‎python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ Calculates interpolation value for map coordinates x, y
8484
:param y: y-coordinate (in map units)
8585
:param feedback: optional feedback object for progress and cancelation support
8686

87-
:return: 0 in case of success*
88-
result: out: interpolation result
87+
:return: - 0 in case of success
88+
- result: interpolation result
8989
%End
9090

9191

‎python/core/auto_generated/expression/qgsexpression.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ Tests whether a string is a valid expression.
250250
:param text: string to test
251251
:param context: optional expression context
252252

253-
:return: true if string is a valid expression
254-
errorMessage: will be filled with any error message from the validation
253+
:return: - true if string is a valid expression
254+
- errorMessage: will be filled with any error message from the validation
255255

256256
.. versionadded:: 2.12
257257
%End

‎python/core/auto_generated/geometry/qgsabstractgeometry.sip.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ Returns next vertex id and coordinates
307307
:param id: initial value should be the starting vertex id. The next vertex id will be stored
308308
in this variable if found.
309309

310-
:return: false if at end
311-
vertex: container for found node
310+
:return: - false if at end
311+
- vertex: container for found node
312312
%End
313313

314314
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const = 0;
@@ -346,8 +346,8 @@ Searches for the closest segment of the geometry to a given point.
346346
:param vertexAfter: storage for the ID of the vertex at the end of the closest segment
347347
:param epsilon: epsilon for segment snapping
348348

349-
:return: squared distance to closest segment or negative value on error
350-
leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) false if point is to right of segment)
349+
:return: - squared distance to closest segment or negative value on error
350+
- leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) false if point is to right of segment)
351351
%End
352352

353353

‎python/core/auto_generated/geometry/qgscurve.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ Returns the point and vertex id of a point within the curve.
136136
:param node: node number, where the first node is 0
137137
:param type: will be set to the vertex type of the node
138138

139-
:return: true if node exists within the curve
140-
point: will be set to point at corresponding node in the curve
139+
:return: - true if node exists within the curve
140+
- point: will be set to point at corresponding node in the curve
141141
%End
142142

143143
virtual QgsCurve *reversed() const = 0 /Factory/;

‎python/core/auto_generated/geometry/qgsgeometry.sip.in

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -633,8 +633,8 @@ Searches for the closest vertex in this geometry to the given point.
633633

634634
:param point: Specifiest the point for search
635635

636-
:return: The squared Cartesian distance is also returned in sqrDist, negative number on error
637-
atVertex: Receives index of the closest vertex
636+
:return: - The squared Cartesian distance is also returned in sqrDist, negative number on error
637+
- atVertex: Receives index of the closest vertex
638638
%End
639639

640640
double closestSegmentWithContext( const QgsPointXY &point, QgsPointXY &minDistPoint /Out/, int &afterVertex /Out/, int *leftOf /Out/ = 0, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
@@ -648,8 +648,8 @@ Searches for the closest segment of geometry to the given point
648648
that the test was unsuccessful, e.g. for a point exactly on the line)
649649
:param epsilon: epsilon for segment snapping
650650

651-
:return: The squared Cartesian distance is also returned in sqrDist, negative number on error
652-
minDistPoint: Receives the nearest point on the segment
651+
:return: - The squared Cartesian distance is also returned in sqrDist, negative number on error
652+
- minDistPoint: Receives the nearest point on the segment
653653
%End
654654

655655
OperationResult addRing( const QVector<QgsPointXY> &ring );
@@ -821,6 +821,9 @@ Returns the minimal enclosing circle for the geometry.
821821
:param radius: Radius of the minimal enclosing circle returned
822822
:param segments: Number of segments used to segment geometry. :py:func:`QgsEllipse.toPolygon`
823823

824+
:return: - the minimal enclosing circle as a QGIS geometry
825+
- center: Center of the minimal enclosing circle returneds
826+
824827
.. versionadded:: 3.0
825828
%End
826829

‎python/core/auto_generated/geometry/qgsgeometryutils.sip.in

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Retrieves the vertices which are before and after the interpolated point at a sp
6767
:param distance: distance to traverse along geometry
6868
:param previousVertex: will be set to previous vertex ID
6969

70-
:return: true if vertices were successfully retrieved
71-
nextVertex: will be set to next vertex ID
70+
:return: - true if vertices were successfully retrieved
71+
- nextVertex: will be set to next vertex ID
7272

7373
.. note::
7474

@@ -98,8 +98,8 @@ supported and is retrieved from the first 3D point amongst ``p1`` and
9898
:param p2: Point on the second line
9999
:param v2: Direction vector of the second line
100100

101-
:return: Whether the lines intersect
102-
intersection: Output parameter, the intersection point
101+
:return: - Whether the lines intersect
102+
- intersection: Output parameter, the intersection point
103103
%End
104104

105105
static bool segmentIntersection( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &q1, const QgsPoint &q2, QgsPoint &intersectionPoint /Out/, bool &isIntersection /Out/, double tolerance = 1e-8, bool acceptImproperIntersection = false );
@@ -114,8 +114,8 @@ Compute the intersection between two segments
114114
:param tolerance: The tolerance to use
115115
:param acceptImproperIntersection: By default, this method returns true only if segments have proper intersection. If set true, returns also true if segments have improper intersection (end of one segment on other segment ; continuous segments).
116116

117-
:return: Whether the segments intersect
118-
intersectionPoint: Output parameter, the intersection point
117+
:return: - Whether the segments intersect
118+
- intersectionPoint: Output parameter, the intersection point
119119
* Example:
120120
.. code-block:: python
121121

@@ -574,8 +574,8 @@ An algorithm to calculate an (approximate) intersection of two lines in 3D.
574574
:param Lb1: is the first point on the second line,
575575
:param Lb2: is the second point on the second line,
576576

577-
:return: true if the intersection can be found, false - otherwise.
578-
intersection: is the result intersection, of it can be found.
577+
:return: - true if the intersection can be found, false - otherwise.
578+
- intersection: is the result intersection, of it can be found.
579579
example:
580580
.. code-block:: python
581581

‎python/core/auto_generated/qgsdistancearea.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ otherwise QgsPoint.project() will be called after QgsUnitTypes.fromUnitToUnitFac
222222
:param distance: must be in meters
223223
:param azimuth: - azimuth in radians, clockwise from North
224224

225-
:return: distance in mapUnits
226-
projectedPoint: calculated projected point
225+
:return: - distance in mapUnits
226+
- projectedPoint: calculated projected point
227227

228228
.. seealso:: :py:func:`sourceCrs`
229229

‎python/core/auto_generated/qgsmaplayer.sip.in

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -651,8 +651,8 @@ Save the current metadata of this layer as the default metadata
651651
record in the users style table in their personal qgis.db)
652652

653653

654-
:return: a QString with any status messages
655-
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default metadata.
654+
:return: - a QString with any status messages
655+
- resultFlag: a reference to a flag that will be set to false if we did not manage to save the default metadata.
656656

657657
.. versionadded:: 3.0
658658
%End
@@ -688,8 +688,8 @@ record in the users style table in their personal qgis.db)
688688
table will be consulted to see if there is a metadata who's
689689
key matches the URI.
690690

691-
:return: a QString with any status messages
692-
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default metadata.
691+
:return: - a QString with any status messages
692+
- resultFlag: a reference to a flag that will be set to false if we did not manage to load the default metadata.
693693

694694
.. versionadded:: 3.0
695695
%End
@@ -751,8 +751,8 @@ exists (either as a .qml file on disk or as a
751751
record in the users style table in their personal qgis.db)
752752

753753

754-
:return: a QString with any status messages
755-
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.
754+
:return: - a QString with any status messages
755+
- resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.
756756

757757
.. seealso:: :py:func:`also`
758758
%End
@@ -770,8 +770,8 @@ record in the users style table in their personal qgis.db)
770770
key matches the URI.
771771
:param categories: the style categories to be loaded.
772772

773-
:return: a QString with any status messages
774-
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.
773+
:return: - a QString with any status messages
774+
- resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.
775775

776776
.. seealso:: :py:func:`also`
777777
%End
@@ -783,8 +783,8 @@ Retrieve a named style for this layer from a sqlite database.
783783
:param db: path to sqlite database
784784
:param uri: uri for table
785785

786-
:return: true if style was successfully loaded
787-
qml: will be set to QML style content from database
786+
:return: - true if style was successfully loaded
787+
- qml: will be set to QML style content from database
788788
%End
789789

790790
virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg /Out/,
@@ -831,8 +831,8 @@ Save the properties of this layer as the default style
831831
record in the users style table in their personal qgis.db)
832832

833833

834-
:return: a QString with any status messages
835-
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.
834+
:return: - a QString with any status messages
835+
- resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.
836836

837837
.. seealso:: :py:func:`loadNamedStyle`
838838
%End
@@ -850,8 +850,8 @@ record in the users style table in their personal qgis.db)
850850
key matches the URI.
851851
:param categories: the style categories to be saved.
852852

853-
:return: a QString with any status messages
854-
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.
853+
:return: - a QString with any status messages
854+
- resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.
855855

856856
.. seealso:: :py:func:`saveDefaultStyle`
857857
%End

‎python/core/auto_generated/qgsproperty.sip.in

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -322,8 +322,8 @@ Calculates the current value of the property, including any transforms which are
322322
is able to respond to the current environment, layers and features within QGIS.
323323
:param defaultValue: default value to return if the property is not active or cannot be calculated
324324

325-
:return: calculated value for property
326-
ok: if specified, will be set to true if conversion was successful
325+
:return: - calculated value for property
326+
- ok: if specified, will be set to true if conversion was successful
327327

328328
.. seealso:: :py:func:`valueAsString`
329329

@@ -343,8 +343,8 @@ Calculates the current value of the property and interprets it as a string.
343343
:param context: QgsExpressionContext to evaluate the property for.
344344
:param defaultString: default string to return if the property cannot be calculated as a string
345345

346-
:return: value parsed to string
347-
ok: if specified, will be set to true if conversion was successful
346+
:return: - value parsed to string
347+
- ok: if specified, will be set to true if conversion was successful
348348

349349
.. seealso:: :py:func:`value`
350350

@@ -364,8 +364,8 @@ Calculates the current value of the property and interprets it as a color.
364364
:param context: QgsExpressionContext to evaluate the property for.
365365
:param defaultColor: default color to return if the property cannot be calculated as a color
366366

367-
:return: value parsed to color
368-
ok: if specified, will be set to true if conversion was successful
367+
:return: - value parsed to color
368+
- ok: if specified, will be set to true if conversion was successful
369369

370370
.. seealso:: :py:func:`value`
371371

@@ -385,8 +385,8 @@ Calculates the current value of the property and interprets it as a double.
385385
:param context: QgsExpressionContext to evaluate the property for.
386386
:param defaultValue: default double to return if the property cannot be calculated as a double
387387

388-
:return: value parsed to double
389-
ok: if specified, will be set to true if conversion was successful
388+
:return: - value parsed to double
389+
- ok: if specified, will be set to true if conversion was successful
390390

391391
.. seealso:: :py:func:`value`
392392

@@ -406,8 +406,8 @@ Calculates the current value of the property and interprets it as an integer.
406406
:param context: QgsExpressionContext to evaluate the property for.
407407
:param defaultValue: default integer to return if the property cannot be calculated as an integer
408408

409-
:return: value parsed to integer
410-
ok: if specified, will be set to true if conversion was successful
409+
:return: - value parsed to integer
410+
- ok: if specified, will be set to true if conversion was successful
411411

412412
.. seealso:: :py:func:`value`
413413

@@ -427,8 +427,8 @@ Calculates the current value of the property and interprets it as an boolean.
427427
:param context: QgsExpressionContext to evaluate the property for.
428428
:param defaultValue: default boolean to return if the property cannot be calculated as an boolean
429429

430-
:return: value parsed to boolean
431-
ok: if specified, will be set to true if conversion was successful
430+
:return: - value parsed to boolean
431+
- ok: if specified, will be set to true if conversion was successful
432432

433433
.. seealso:: :py:func:`value`
434434

‎python/core/auto_generated/qgspropertycollection.sip.in

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ Calculates the current value of the property with the specified key and interpre
118118
:param context: QgsExpressionContext to evaluate the property for.
119119
:param defaultString: default string to return if the property cannot be calculated as a string
120120

121-
:return: value parsed to string
122-
ok: if specified, will be set to true if conversion was successful
121+
:return: - value parsed to string
122+
- ok: if specified, will be set to true if conversion was successful
123123

124124
.. seealso:: :py:func:`value`
125125

@@ -141,8 +141,8 @@ Calculates the current value of the property with the specified key and interpre
141141
:param context: QgsExpressionContext to evaluate the property for.
142142
:param defaultColor: default color to return if the property cannot be calculated as a color
143143

144-
:return: value parsed to color
145-
ok: if specified, will be set to true if conversion was successful
144+
:return: - value parsed to color
145+
- ok: if specified, will be set to true if conversion was successful
146146

147147
.. seealso:: :py:func:`value`
148148

@@ -164,8 +164,8 @@ Calculates the current value of the property with the specified key and interpre
164164
:param context: QgsExpressionContext to evaluate the property for.
165165
:param defaultValue: default double to return if the property cannot be calculated as a double
166166

167-
:return: value parsed to double
168-
ok: if specified, will be set to true if conversion was successful
167+
:return: - value parsed to double
168+
- ok: if specified, will be set to true if conversion was successful
169169

170170
.. seealso:: :py:func:`value`
171171

@@ -187,8 +187,8 @@ Calculates the current value of the property with the specified key and interpre
187187
:param context: QgsExpressionContext to evaluate the property for.
188188
:param defaultValue: default integer to return if the property cannot be calculated as a integer
189189

190-
:return: value parsed to integer
191-
ok: if specified, will be set to true if conversion was successful
190+
:return: - value parsed to integer
191+
- ok: if specified, will be set to true if conversion was successful
192192

193193
.. seealso:: :py:func:`value`
194194

@@ -210,8 +210,8 @@ Calculates the current value of the property with the specified key and interpre
210210
:param context: QgsExpressionContext to evaluate the property for.
211211
:param defaultValue: default boolean to return if the property cannot be calculated as a boolean
212212

213-
:return: value parsed to bool
214-
ok: if specified, will be set to true if conversion was successful
213+
:return: - value parsed to bool
214+
- ok: if specified, will be set to true if conversion was successful
215215

216216
.. seealso:: :py:func:`value`
217217

‎python/core/auto_generated/qgspropertytransformer.sip.in

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,8 +299,8 @@ Attempts to parse an expression into a corresponding property transformer.
299299
to the property transformer. This will be set to an
300300
empty string if an expression is the transformer input.
301301

302-
:return: corresponding property transformer, or None if expression could not
303-
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
302+
:return: - corresponding property transformer, or None if expression could not
303+
- baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
304304
be parsed to a transformer.
305305
%End
306306

@@ -366,8 +366,8 @@ Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTran
366366
to the property transformer. This will be set to an
367367
empty string if an expression is the transformer input.
368368

369-
:return: corresponding :py:class:`QgsSizeScaleTransformer`, or None if expression could not
370-
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
369+
:return: - corresponding :py:class:`QgsSizeScaleTransformer`, or None if expression could not
370+
- baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
371371
be parsed to a size scale transformer.
372372
%End
373373

@@ -513,8 +513,8 @@ Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.
513513
to the property transformer. This will be set to an
514514
empty string if an expression is the transformer input.
515515

516-
:return: corresponding QgsSizeScaleTransformer, or None if expression could not
517-
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
516+
:return: - corresponding QgsSizeScaleTransformer, or None if expression could not
517+
- baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
518518
be parsed to a size scale transformer.
519519
%End
520520

‎python/core/auto_generated/qgstransaction.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ Execute the ``sql`` string.
9292
:param isDirty: Flag to indicate if the underlying data will be modified
9393
:param name: Name of the transaction ( only used if `isDirty` is true)
9494

95-
:return: true if everything is OK, false otherwise
96-
error: The error message
95+
:return: - true if everything is OK, false otherwise
96+
- error: The error message
9797
%End
9898

9999
static bool supportsTransaction( const QgsVectorLayer *layer );

0 commit comments

Comments
 (0)
Please sign in to comment.