sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

run sipify

Browse Source
This commit is contained in:
Denis Rouzaud 2018-12-18 17:17:25 -04:00
parent 9b852fbf35
commit edfb7e1465
28 changed files with 49 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in
View File

@ -82,10 +82,10 @@ 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*
result: out: interpolation result
%End

2
python/core/auto_generated/expression/qgsexpression.sip.in
View File

@ -249,9 +249,9 @@ Tests whether a string is a valid expression.
:param text: string to test
:param context: optional expression context
:param errorMessage: will be filled with any error message from the validation
:return: true if string is a valid expression
errorMessage: will be filled with any error message from the validation
.. versionadded:: 2.12
%End

4
python/core/auto_generated/geometry/qgsabstractgeometry.sip.in
View File

@ -306,9 +306,9 @@ Returns next vertex id and coordinates
:param id: initial value should be the starting vertex id. The next vertex id will be stored
in this variable if found.
:param vertex: container for found node
:return: false if at end
vertex: container for found node
%End
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const = 0;
@ -344,13 +344,13 @@ Searches for the closest segment of the geometry to a given point.
:param pt: specifies the point to find closest segment to
:param segmentPt: storage for the closest point within the geometry
:param vertexAfter: storage for the ID of the vertex at the end of the closest segment
:param 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)
:param epsilon: epsilon for segment snapping
:return: squared distance to closest segment or negative value on error
leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left
%End

2
python/core/auto_generated/geometry/qgscurve.sip.in
View File

@ -134,10 +134,10 @@ Sums up the area of the curve by iterating over the vertices (shoelace formula).
Returns the point and vertex id of a point within the curve.
:param node: node number, where the first node is 0
:param point: will be set to point at corresponding node in the curve
:param type: will be set to the vertex type of the node
:return: true if node exists within the curve
point: will be set to point at corresponding node in the curve
%End
virtual QgsCurve *reversed() const = 0 /Factory/;

6
python/core/auto_generated/geometry/qgsgeometry.sip.in
View File

@ -632,9 +632,9 @@ Returns the shortest line joining this geometry to another geometry.
Searches for the closest vertex in this geometry to the given point.
:param point: Specifiest the point for search
:param atVertex: Receives index of the closest vertex
:return: The squared Cartesian distance is also returned in sqrDist, negative number on error
atVertex: Receives index of the closest vertex
%End
double closestSegmentWithContext( const QgsPointXY &point, QgsPointXY &minDistPoint /Out/, int &afterVertex /Out/, int *leftOf /Out/ = 0, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
@ -642,7 +642,6 @@ Searches for the closest vertex in this geometry to the given point.
Searches for the closest segment of geometry to the given point
:param point: Specifies the point for search
:param minDistPoint: Receives the nearest point on the segment
:param afterVertex: Receives index of the vertex after the closest segment. The vertex
before the closest segment is always afterVertex - 1
:param leftOf: Out: Returns if the point lies on the left of left side of the geometry ( < 0 means left, > 0 means right, 0 indicates
@ -650,6 +649,7 @@ Searches for the closest segment of geometry to the given point
:param epsilon: epsilon for segment snapping
:return: The squared Cartesian distance is also returned in sqrDist, negative number on error
minDistPoint: Receives the nearest point on the segment
%End
OperationResult addRing( const QVector<QgsPointXY> &ring );
@ -818,7 +818,6 @@ width and height of the rotated bounding box will also be returned.
%Docstring
Returns the minimal enclosing circle for the geometry.
:param center: Center of the minimal enclosing circle returneds
:param radius: Radius of the minimal enclosing circle returned
:param segments: Number of segments used to segment geometry. :py:func:`QgsEllipse.toPolygon`
@ -1593,7 +1592,6 @@ Modifies geometry to avoid intersections with the layers specified in project pr
3 other error during intersection removal
:param avoidIntersectionsLayers: list of layers to check for intersections
:param ignoreFeatures: possibility to give a list of features where intersections should be ignored (not available in Python bindings)
.. versionadded:: 1.5
%End

9
python/core/auto_generated/geometry/qgsgeometryutils.sip.in
View File

@ -66,9 +66,9 @@ Retrieves the vertices which are before and after the interpolated point at a sp
:param geometry: line or polygon geometry
:param distance: distance to traverse along geometry
:param previousVertex: will be set to previous vertex ID
:param nextVertex: will be set to next vertex ID
:return: true if vertices were successfully retrieved
nextVertex: will be set to next vertex ID
.. note::
@ -97,9 +97,9 @@ supported and is retrieved from the first 3D point amongst ``p1`` and
:param v1: Direction vector of the first line
:param p2: Point on the second line
:param v2: Direction vector of the second line
:param intersection: Output parameter, the intersection point
:return: Whether the lines intersect
intersection: Output parameter, the intersection point
%End
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 );
@ -110,12 +110,12 @@ Compute the intersection between two segments
:param p2: First segment end point
:param q1: Second segment start point
:param q2: Second segment end point
:param intersectionPoint: Output parameter, the intersection point
:param isIntersection: Output parameter, return true if an intersection is found
:param tolerance: The tolerance to use
: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).
:return: Whether the segments intersect
intersectionPoint: Output parameter, the intersection point
* Example:
.. code-block:: python
@ -515,7 +515,6 @@ Returns the coefficients (a, b, c for equation "ax + by + c = 0") of a line defi
:param pt1: first point.
:param pt2: second point.
:param a: Output parameter, a coefficient of the equation.
:param b: Output parameter, b coefficient of the equation.
:param c: Output parameter, c coefficient of the equation.
@ -574,9 +573,9 @@ An algorithm to calculate an (approximate) intersection of two lines in 3D.
:param La2: is the second point on the first line,
:param Lb1: is the first point on the second line,
:param Lb2: is the second point on the second line,
:param intersection: is the result intersection, of it can be found.
:return: true if the intersection can be found, false - otherwise.
intersection: is the result intersection, of it can be found.
example:
.. code-block:: python

2
python/core/auto_generated/qgsdistancearea.sip.in
View File

@ -221,9 +221,9 @@ otherwise QgsPoint.project() will be called after QgsUnitTypes.fromUnitToUnitFac
:param p1: start point [can be Cartesian or Geographic]
:param distance: must be in meters
:param azimuth: - azimuth in radians, clockwise from North
:param projectedPoint: calculated projected point
:return: distance in mapUnits
projectedPoint: calculated projected point
.. seealso:: :py:func:`sourceCrs`

14
python/core/auto_generated/qgsmaplayer.sip.in
View File

@ -650,10 +650,10 @@ Save the current metadata of this layer as the default metadata
(either as a .qmd file on disk or as a
record in the users style table in their personal qgis.db)
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to save the default metadata.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. versionadded:: 3.0
%End
@ -688,10 +688,10 @@ record in the users style table in their personal qgis.db)
is a file and load that, if that fails the qgis.db metadata
table will be consulted to see if there is a metadata who's
key matches the URI.
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to load the default metadata.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. versionadded:: 3.0
%End
@ -752,10 +752,10 @@ Retrieve the default style for this layer if one
exists (either as a .qml file on disk or as a
record in the users style table in their personal qgis.db)
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to load the default style.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. seealso:: :py:func:`also`
%End
@ -771,11 +771,11 @@ record in the users style table in their personal qgis.db)
is a file and load that, if that fails the qgis.db styles
table will be consulted to see if there is a style who's
key matches the URI.
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to load the default style.
:param categories: the style categories to be loaded.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. seealso:: :py:func:`also`
%End
@ -786,9 +786,9 @@ Retrieve a named style for this layer from a sqlite database.
:param db: path to sqlite database
:param uri: uri for table
:param qml: will be set to QML style content from database
:return: true if style was successfully loaded
qml: will be set to QML style content from database
%End
virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg /Out/,
@ -834,10 +834,10 @@ Save the properties of this layer as the default style
(either as a .qml file on disk or as a
record in the users style table in their personal qgis.db)
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to save the default style.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. seealso:: :py:func:`loadNamedStyle`
%End
@ -853,11 +853,11 @@ record in the users style table in their personal qgis.db)
is a file and save to that, if that fails the qgis.db styles
table will be used to create a style entry who's
key matches the URI.
:param resultFlag: a reference to a flag that will be set to false if
we did not manage to save the default style.
:param categories: the style categories to be saved.
:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
.. seealso:: :py:func:`saveDefaultStyle`
%End

2
python/core/auto_generated/qgsmaplayerstore.sip.in
View File

@ -119,7 +119,6 @@ to the store.
The layersAdded() and layerWasAdded() signals will always be emitted.
:param layers: A list of layer which should be added to the store.
:param takeOwnership: Ownership will be transferred to the layer store.
If you specify false here you have take care of deleting
the layers yourself. Not available in Python.
@ -142,7 +141,6 @@ If you are adding multiple layers at once, you should use
addMapLayers() instead.
:param layer: A layer to add to the store
:param takeOwnership: Ownership will be transferred to the layer store.
If you specify false here you have take care of deleting
the layers yourself. Not available in Python.

1
python/core/auto_generated/qgspallabeling.sip.in
View File

@ -398,7 +398,6 @@ Register a feature for labeling.
must have already had the feature and fields sets prior to calling this method.
:param labelFeature: if using :py:class:`QgsLabelingEngine`, this will receive the label feature. Not available
in Python bindings.
:param obstacleGeometry: optional obstacle geometry, if a different geometry to the feature's geometry
should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point
symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set,
the feature's original geometry will be used as an obstacle for labels. Not available

2
python/core/auto_generated/qgsproject.sip.in
View File

@ -765,7 +765,6 @@ The legendLayersAdded() signal is emitted only if addToLegend is true.
:param addToLegend: If true (by default), the layers will be added to the
legend and to the main canvas. If you have a private
layer you can set this parameter to false to hide it.
:param takeOwnership: Ownership will be transferred to the layer registry.
If you specify false here you have take care of deleting
the layers yourself. Not available in Python.
@ -803,7 +802,6 @@ addMapLayers() instead.
:param addToLegend: If true (by default), the layer will be added to the
legend and to the main canvas. If you have a private
layer you can set this parameter to false to hide it.
:param takeOwnership: Ownership will be transferred to the layer registry.
If you specify false here you have take care of deleting
the layer yourself. Not available in Python.

12
python/core/auto_generated/qgsproperty.sip.in
View File

@ -321,9 +321,9 @@ Calculates the current value of the property, including any transforms which are
in the expression context can be used to alter the calculated value for the property, so that a property
is able to respond to the current environment, layers and features within QGIS.
:param defaultValue: default value to return if the property is not active or cannot be calculated
:param ok: if specified, will be set to true if conversion was successful
:return: calculated value for property
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`valueAsString`
@ -342,9 +342,9 @@ Calculates the current value of the property and interprets it as a string.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultString: default string to return if the property cannot be calculated as a string
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to string
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -363,9 +363,9 @@ Calculates the current value of the property and interprets it as a color.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultColor: default color to return if the property cannot be calculated as a color
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to color
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -384,9 +384,9 @@ Calculates the current value of the property and interprets it as a double.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default double to return if the property cannot be calculated as a double
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to double
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -405,9 +405,9 @@ Calculates the current value of the property and interprets it as an integer.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default integer to return if the property cannot be calculated as an integer
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to integer
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -426,9 +426,9 @@ Calculates the current value of the property and interprets it as an boolean.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default boolean to return if the property cannot be calculated as an boolean
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to boolean
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`

10
python/core/auto_generated/qgspropertycollection.sip.in
View File

@ -117,9 +117,9 @@ Calculates the current value of the property with the specified key and interpre
int and used for the key value.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultString: default string to return if the property cannot be calculated as a string
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to string
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -140,9 +140,9 @@ Calculates the current value of the property with the specified key and interpre
int and used for the key value.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultColor: default color to return if the property cannot be calculated as a color
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to color
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -163,9 +163,9 @@ Calculates the current value of the property with the specified key and interpre
int and used for the key value.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default double to return if the property cannot be calculated as a double
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to double
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -186,9 +186,9 @@ Calculates the current value of the property with the specified key and interpre
int and used for the key value.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default integer to return if the property cannot be calculated as a integer
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to integer
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`
@ -209,9 +209,9 @@ Calculates the current value of the property with the specified key and interpre
int and used for the key value.
:param context: QgsExpressionContext to evaluate the property for.
:param defaultValue: default boolean to return if the property cannot be calculated as a boolean
:param ok: if specified, will be set to true if conversion was successful
:return: value parsed to bool
ok: if specified, will be set to true if conversion was successful
.. seealso:: :py:func:`value`

6
python/core/auto_generated/qgspropertytransformer.sip.in
View File

@ -295,7 +295,6 @@ of a sub-expression reflecting the parent property's state.
Attempts to parse an expression into a corresponding property transformer.
:param expression: expression to parse
:param 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.
:param fieldName: will be set to a field name which is used to calculate the input
@ -303,6 +302,7 @@ Attempts to parse an expression into a corresponding property transformer.
empty string if an expression is the transformer input.
:return: corresponding property transformer, or None if expression could not
baseExpression: will be set to the component of the source expression which
be parsed to a transformer.
%End
@ -364,7 +364,6 @@ Constructor for QgsGenericNumericTransformer.
Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTransformer`.
:param expression: expression to parse
:param 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.
:param fieldName: will be set to a field name which is used to calculate the input
@ -372,6 +371,7 @@ Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTran
empty string if an expression is the transformer input.
:return: corresponding :py:class:`QgsSizeScaleTransformer`, or None if expression could not
baseExpression: will be set to the component of the source expression which
be parsed to a size scale transformer.
%End
@ -513,7 +513,6 @@ Constructor for QgsSizeScaleTransformer.
Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.
:param expression: expression to parse
:param 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.
:param fieldName: will be set to a field name which is used to calculate the input
@ -521,6 +520,7 @@ Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.
empty string if an expression is the transformer input.
:return: corresponding QgsSizeScaleTransformer, or None if expression could not
baseExpression: will be set to the component of the source expression which
be parsed to a size scale transformer.
%End

2
python/core/auto_generated/qgstransaction.sip.in
View File

@ -89,11 +89,11 @@ Roll back transaction.
Execute the ``sql`` string.
:param sql: The sql query to execute
:param error: The error message
:param isDirty: Flag to indicate if the underlying data will be modified
:param name: Name of the transaction ( only used if `isDirty` is true)
:return: true if everything is OK, false otherwise
error: The error message
%End
static bool supportsTransaction( const QgsVectorLayer *layer );

12
python/core/auto_generated/qgsunittypes.sip.in
View File

@ -152,9 +152,9 @@ Encodes a distance unit to a string.
Decodes a distance unit from a string.
:param string: string to decode
:param ok: optional boolean, will be set to true if string was converted successfully
:return: decoded units
ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`encodeUnit`
%End
@ -184,7 +184,6 @@ Returns a translated abbreviation representing a distance unit.
Converts a translated string to a distance unit.
:param string: string representing a distance unit
:param ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`toString`
%End
@ -221,9 +220,9 @@ Encodes an areal unit to a string.
Decodes an areal unit from a string.
:param string: string to decode
:param ok: optional boolean, will be set to true if string was converted successfully
:return: decoded units
ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`encodeUnit`
%End
@ -253,7 +252,6 @@ Returns a translated abbreviation representing an areal unit.
Converts a translated string to an areal unit.
:param string: string representing an areal unit
:param ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`toString`
%End
@ -294,9 +292,9 @@ Encodes an angular unit to a string.
Decodes an angular unit from a string.
:param string: string to decode
:param ok: optional boolean, will be set to true if string was converted successfully
:return: decoded units
ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`encodeUnit`
%End
@ -403,9 +401,9 @@ Encodes a render unit to a string.
Decodes a render unit from a string.
:param string: string to decode
:param ok: optional boolean, will be set to true if string was converted successfully
:return: decoded units
ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`encodeUnit`
%End
@ -437,9 +435,9 @@ Encodes a layout unit to a string.
Decodes a layout unit from a string.
:param string: string to decode
:param ok: optional boolean, will be set to true if string was converted successfully
:return: decoded units
ok: optional boolean, will be set to true if string was converted successfully
.. seealso:: :py:func:`encodeUnit`

1
python/core/auto_generated/qgsvectordataprovider.sip.in
View File

@ -228,7 +228,6 @@ Returns the possible enum values of an attribute. Returns an empty stringlist if
or if the given attribute is not an enum type.
:param index: the index of the attribute
:param enumList: reference to the list to fill
%End
virtual bool addFeatures( QgsFeatureList &flist /In,Out/, QgsFeatureSink::Flags flags = 0 );

5
python/core/auto_generated/qgsvectorlayer.sip.in
View File

@ -786,7 +786,6 @@ Save named and sld style of the layer to the style table in the db.
:param description:
:param useAsDefault:
:param uiFileContent:
:param msgError:
%End
virtual int listStylesInDatabase( QStringList &ids /Out/, QStringList &names /Out/,
@ -796,10 +795,10 @@ Lists all the style in db split into related to the layer and not related to
:param ids: the list in which will be stored the style db ids
:param names: the list in which will be stored the style names
:param descriptions: the list in which will be stored the style descriptions
:param msgError:
:return: the number of styles related to current layer
descriptions: the list in which will be stored the style descriptions
.. note::
@ -816,9 +815,9 @@ Will return the named style corresponding to style id provided
Delete a style from the database
:param styleId: the provider's layer_styles table id of the style to delete
:param msgError: reference to string that will be updated with any error messages
:return: true in case of success
msgError: reference to string that will be updated with any error messages
.. versionadded:: 3.0
%End

1
python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in
View File

@ -85,7 +85,6 @@ Finds the vector join for a layer field index.
:param index: this layers attribute index
:param fields: fields of the vector layer (including joined fields)
:param sourceFieldIndex: Output: field's index in source layer *
%End
int joinedFieldsOffset( const QgsVectorLayerJoinInfo *info, const QgsFields &fields );

4
python/core/auto_generated/qgsvectorlayertools.sip.in
View File

@ -34,9 +34,9 @@ This method should/will be called, whenever a new feature will be added to the l
:param layer: The layer to which the feature should be added
:param defaultValues: Default values for the feature to add
:param defaultGeometry: A default geometry to add to the feature
:param feature: Updated feature after adding will be written back to this
:return: True in case of success, False if the operation failed/was aborted
feature: Updated feature after adding will be written back to this
TODO QGIS 3: remove const qualifier
%End
@ -86,9 +86,9 @@ Copy and move features with defined translation.
:param request: The request for the features to be moved. It will be assigned to a new feature request with the newly copied features.
:param dx: The translation on x
:param dy: The translation on y
:param errorMsg: If given, it will contain the error message
:return: True if all features could be copied.
errorMsg: If given, it will contain the error message
TODO QGIS 3: remove const qualifier
%End

1
python/core/auto_generated/qgsziputils.sip.in
View File

@ -33,7 +33,6 @@ not writable.
:param zip: The zip filename
:param dir: The output directory
:param files: The absolute path of unzipped files
.. versionadded:: 3.0
%End

4
python/core/auto_generated/raster/qgsrastershader.sip.in
View File

@ -58,9 +58,9 @@ Generates a new RGBA value based on one input ``value``.
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value
:return: True if the return values are valid otherwise false
returnAlpha: The alpha component of the new RGBA value
%End
bool shade( double redValue,
@ -81,9 +81,9 @@ Generates a new RGBA value based on an original RGBA value.
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value
:return: True if the return values are valid otherwise false
returnAlpha: The alpha component of the new RGBA value
%End
void setRasterShaderFunction( QgsRasterShaderFunction *function /Transfer/ );

4
python/core/auto_generated/raster/qgsrastershaderfunction.sip.in
View File

@ -62,9 +62,9 @@ Generates an new RGBA value based on one input ``value``.
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value
:return: True if the return values are valid otherwise false
returnAlpha: The alpha component of the new RGBA value
%End
virtual bool shade( double redValue,
@ -85,9 +85,9 @@ Generates an new RGBA value based on an original RGBA value.
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value
:return: True if the return values are valid otherwise false
returnAlpha: The alpha component of the new RGBA value
%End
double minimumMaximumRange() const;

2
python/gui/auto_generated/editorwidgets/core/qgseditorwidgetautoconf.sip.in
View File

@ -32,9 +32,9 @@ Typical scores are:
:param vl: The vector layer for which this widget will be created
:param fieldName: The field name on the specified layer for which this widget will be created
:param score: Where the score is returned (default to 0)
:return: and integer value rating how good is the setup provided by this plugin.
score: Where the score is returned (default to 0)
%End
};

2
python/gui/auto_generated/editorwidgets/core/qgseditorwidgetregistry.sip.in
View File

@ -74,7 +74,6 @@ The editor may be NULL if you want the widget wrapper to create a default widget
:param config: A configuration which should be used for the widget creation
:param editor: An editor widget which will be used instead of an autocreated widget
:param parent: The parent which will be used for the created wrapper and the created widget
:param context: The editor context (not available in Python bindings)
:return: A new widget wrapper
%End
@ -92,7 +91,6 @@ The editor may be NULL if you want the widget wrapper to create a default widget
:param fieldIdx: The field index on the specified layer for which this widget will be created
:param editor: An editor widget which will be used instead of an autocreated widget
:param parent: The parent which will be used for the created wrapper and the created widget
:param context: The editor context (not available in Python bindings)
:return: A new widget wrapper
%End

1
python/gui/auto_generated/qgsattributeformwidget.sip.in
View File

@ -42,7 +42,6 @@ A new form widget for the wrapper ``widget`` on ``form``.
Creates the search widget wrappers for the widget used when the form is in
search mode.
:param context: editor context (not available in Python bindings)
%End
virtual QString currentFilterExpression() const;

1
python/gui/auto_generated/qgsexpressionlineedit.sip.in
View File

@ -112,7 +112,6 @@ Returns the current expression shown in the widget.
%Docstring
Returns true if the current expression is valid.
:param expressionError: will be set to any generated error message if specified
%End
void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator );

2
python/server/auto_generated/qgsserverexception.sip.in
View File

@ -38,9 +38,9 @@ Constructor
%Docstring
Format the exception for sending to client
:param responseFormat: QString to store the content type of the response format.
:return: QByteArray the fermatted response.
responseFormat: QString to store the content type of the response format.
The defaolt implementation return text/xml format.
%End