run sipify

qgis · Dec 15, 2017 · f2b3ed0 · f2b3ed0
1 parent 2009d4c
commit f2b3ed0
Show file tree

Hide file tree

Showing 795 changed files with 49,280 additions and 32,440 deletions.
diff --git a/python/analysis/interpolation/qgsgridfilewriter.sip b/python/analysis/interpolation/qgsgridfilewriter.sip
@@ -20,21 +20,22 @@ class QgsGridFileWriter
 
     QgsGridFileWriter( QgsInterpolator *interpolator, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows );
 %Docstring
- Constructor for QgsGridFileWriter, for the specified ``interpolator``.
+Constructor for QgsGridFileWriter, for the specified ``interpolator``.
 
- The ``outputPath`` argument is used to set the output file path.
+The ``outputPath`` argument is used to set the output file path.
 
- The ``extent`` and ``nCols``, ``nRows`` arguments dictate the extent and size of the output raster.
+The ``extent`` and ``nCols``, ``nRows`` arguments dictate the extent and size of the output raster.
 %End
 
     int writeFile( QgsFeedback *feedback = 0 );
 %Docstring
- Writes the grid file.
+Writes the grid file.
 
- An optional ``feedback`` object can be set for progress reports and cancelation support
+An optional ``feedback`` object can be set for progress reports and cancelation support
+
+:return: 0 in case of success
+:rtype: int
 
- :return: 0 in case of success
- :rtype: int
 %End
 
 };

diff --git a/python/analysis/interpolation/qgsidwinterpolator.sip b/python/analysis/interpolation/qgsidwinterpolator.sip
@@ -12,7 +12,7 @@
 class QgsIDWInterpolator: QgsInterpolator
 {
 %Docstring
- Inverse distance weight interpolator.
+Inverse distance weight interpolator.
 %End
 
 %TypeHeaderCode
@@ -22,34 +22,37 @@ class QgsIDWInterpolator: QgsInterpolator
 
     QgsIDWInterpolator( const QList<QgsInterpolator::LayerData> &layerData );
 %Docstring
- Constructor for QgsIDWInterpolator, with the specified ``layerData`` sources.
+Constructor for QgsIDWInterpolator, with the specified ``layerData`` sources.
 %End
 
     virtual int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback = 0 );
 
 
     void setDistanceCoefficient( double coefficient );
 %Docstring
- Sets the distance ``coefficient``, the parameter that sets how the values are
- weighted with distance. Smaller values mean sharper peaks at the data points.
+Sets the distance ``coefficient``, the parameter that sets how the values are
+weighted with distance. Smaller values mean sharper peaks at the data points.
 
- Point values are weighted by 1 / ( distance ^ coefficient ).
+Point values are weighted by 1 / ( distance ^ coefficient ).
 
 .. seealso:: :py:func:`distanceCoefficient()`
+
 .. versionadded:: 3.0
 %End
 
     double distanceCoefficient() const;
 %Docstring
- Returns the distance coefficient, the parameter that sets how the values are
- weighted with distance. Smaller values mean sharper peaks at the data points.
- The default is a coefficient of 2.
+Returns the distance coefficient, the parameter that sets how the values are
+weighted with distance. Smaller values mean sharper peaks at the data points.
+The default is a coefficient of 2.
+
+Point values are weighted by 1 / ( distance ^ coefficient ).
 
- Point values are weighted by 1 / ( distance ^ coefficient ).
+:rtype: float
 
 .. seealso:: :py:func:`setDistanceCoefficient()`
+
 .. versionadded:: 3.0
- :rtype: float
 %End
 
 };

diff --git a/python/analysis/interpolation/qgsinterpolator.sip b/python/analysis/interpolation/qgsinterpolator.sip
@@ -15,8 +15,8 @@ struct QgsInterpolatorVertexData
 
   QgsInterpolatorVertexData( double x, double y, double z );
 %Docstring
- Constructor for QgsInterpolatorVertexData with the specified
- ``x``, ``y``, and ``z`` coordinate.
+Constructor for QgsInterpolatorVertexData with the specified
+``x``, ``y``, and ``z`` coordinate.
 %End
 
   QgsInterpolatorVertexData();
@@ -41,9 +41,9 @@ Z-coordinate
 class QgsInterpolator
 {
 %Docstring
- Interface class for interpolations. Interpolators take
- the vertices of a vector layer as base data. The z-Value
- can be an attribute or the z-coordinates in case of 3D types.
+Interface class for interpolations. Interpolators take
+the vertices of a vector layer as base data. The z-Value
+can be an attribute or the z-coordinates in case of 3D types.
 %End
 
 %TypeHeaderCode
@@ -99,28 +99,31 @@ Source type
 
     virtual int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback = 0 ) = 0;
 %Docstring
- Calculates interpolation value for map coordinates x, y
- \param x x-coordinate (in map units)
- \param y y-coordinate (in map units)
- \param result out: interpolation result
- \param feedback optional feedback object for progress and cancelation support
- :return: 0 in case of success*
- :rtype: int
+Calculates interpolation value for map coordinates x, y
+:param x: x-coordinate (in map units)
+:param y: y-coordinate (in map units)
+:param result: out: interpolation result
+:param feedback: optional feedback object for progress and cancelation support
+
+:return: 0 in case of success*
+:rtype: int
+
 %End
 
 
   protected:
 
     Result cacheBaseData( QgsFeedback *feedback = 0 );
 %Docstring
- Caches the vertex and value data from the provider. All the vertex data
- will be held in virtual memory.
+Caches the vertex and value data from the provider. All the vertex data
+will be held in virtual memory.
+
+An optional ``feedback`` argument may be specified to allow cancelation and
+progress reports from the cache operation.
 
- An optional ``feedback`` argument may be specified to allow cancelation and
- progress reports from the cache operation.
+:return: Success in case of success
+:rtype: Result
 
- :return: Success in case of success
- :rtype: Result
 %End
 
 

diff --git a/python/analysis/interpolation/qgstininterpolator.sip b/python/analysis/interpolation/qgstininterpolator.sip
@@ -13,7 +13,8 @@
 class QgsTinInterpolator: QgsInterpolator
 {
 %Docstring
-  Interpolation in a triangular irregular network
+Interpolation in a triangular irregular network
+
 .. versionadded:: 3.0
 %End
 
@@ -30,9 +31,9 @@ class QgsTinInterpolator: QgsInterpolator
 
     QgsTinInterpolator( const QList<QgsInterpolator::LayerData> &inputData, TinInterpolation interpolation = Linear, QgsFeedback *feedback = 0 );
 %Docstring
- Constructor for QgsTinInterpolator.
- The ``feedback`` object specifies an optional QgsFeedback object for progress reports and cancelation support.
- Ownership of ``feedback`` is not transferred and callers must ensure that it exists for the lifetime of this object.
+Constructor for QgsTinInterpolator.
+The ``feedback`` object specifies an optional QgsFeedback object for progress reports and cancelation support.
+Ownership of ``feedback`` is not transferred and callers must ensure that it exists for the lifetime of this object.
 %End
     ~QgsTinInterpolator();
 
@@ -41,22 +42,26 @@ class QgsTinInterpolator: QgsInterpolator
 
     static QgsFields triangulationFields();
 %Docstring
- Returns the fields output by features when saving the triangulation.
- These fields should be used when creating
- a suitable feature sink for setTriangulationSink()
+Returns the fields output by features when saving the triangulation.
+These fields should be used when creating
+a suitable feature sink for setTriangulationSink()
+
+:rtype: QgsFields
+
 .. seealso:: :py:func:`setTriangulationSink()`
+
 .. versionadded:: 3.0
- :rtype: QgsFields
 %End
 
     void setTriangulationSink( QgsFeatureSink *sink );
 %Docstring
- Sets the optional ``sink`` for saving the triangulation features.
+Sets the optional ``sink`` for saving the triangulation features.
 
- The sink must be setup to accept LineString features, with fields matching
- those returned by triangulationFields().
+The sink must be setup to accept LineString features, with fields matching
+those returned by triangulationFields().
 
 .. seealso:: :py:func:`triangulationFields()`
+
 .. versionadded:: 3.0
 %End