Fix incorrect param docstring when doxygen \param has extra

trailing spaces or uses tabs
qgis · May 27, 2018 · 9f650fe · 9f650fe
1 parent 4b1b752
commit 9f650fe
Show file tree

Hide file tree

Showing 55 changed files with 245 additions and 241 deletions.
diff --git a/python/analysis/auto_generated/network/qgsgraphbuilderinterface.sip.in b/python/analysis/auto_generated/network/qgsgraphbuilderinterface.sip.in
@@ -80,9 +80,9 @@ Add vertex to the graph
 Add edge to the graph
 
 :param pt1id: first vertex identificator
-:param pt1:   first vertex coordinates
+:param pt1: first vertex coordinates
 :param pt2id: second vertex identificator
-:param pt2:   second vertex coordinates
+:param pt2: second vertex coordinates
 :param strategies: optimization strategies
 
 .. note::

diff --git a/python/core/auto_generated/diagram/qgsdiagram.sip.in b/python/core/auto_generated/diagram/qgsdiagram.sip.in
@@ -83,17 +83,17 @@ Constructor for QgsDiagram.
 Changes the pen width to match the current settings and rendering context
 
 :param pen: The pen to modify
-:param s:   The settings that specify the pen width
-:param c:   The rendering specifying the proper scale units for pixel conversion
+:param s: The settings that specify the pen width
+:param c: The rendering specifying the proper scale units for pixel conversion
 %End
 
     QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c );
 %Docstring
 Calculates a size to match the current settings and rendering context
 
 :param size: The size to convert
-:param s:    The settings that specify the size type
-:param c:    The rendering specifying the proper scale units for pixel conversion
+:param s: The settings that specify the size type
+:param c: The rendering specifying the proper scale units for pixel conversion
 
 :return: The converted size for rendering
 %End
@@ -102,9 +102,9 @@ Calculates a size to match the current settings and rendering context
 %Docstring
 Calculates a length to match the current settings and rendering context
 
-:param l:    The length to convert
-:param s:    Unused
-:param c:    The rendering specifying the proper scale units for pixel conversion
+:param l: The length to convert
+:param s: Unused
+:param c: The rendering specifying the proper scale units for pixel conversion
 
 :return: The converted length for rendering
 %End
@@ -113,8 +113,8 @@ Calculates a length to match the current settings and rendering context
 %Docstring
 Calculates a size to match the current settings and rendering context
 
-:param s:    The settings that contain the font size and size type
-:param c:    The rendering specifying the proper scale units for pixel conversion
+:param s: The settings that contain the font size and size type
+:param c: The rendering specifying the proper scale units for pixel conversion
 
 :return: The properly scaled font for rendering
 %End

diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -905,11 +905,11 @@ of segments used to approximate curves
 %Docstring
 Returns a buffer region around the geometry, with additional style options.
 
-:param distance:    buffer distance
-:param segments:    for round joins, number of segments to approximate quarter-circle
+:param distance: buffer distance
+:param segments: for round joins, number of segments to approximate quarter-circle
 :param endCapStyle: end cap style
-:param joinStyle:   join style for corners in geometry
-:param miterLimit:  limit on the miter ratio used for very sharp corners (JoinStyleMiter only)
+:param joinStyle: join style for corners in geometry
+:param miterLimit: limit on the miter ratio used for very sharp corners (JoinStyleMiter only)
 
 .. versionadded:: 2.4
 
@@ -922,10 +922,10 @@ Returns a buffer region around the geometry, with additional style options.
 %Docstring
 Returns an offset line at a given distance and side from an input line.
 
-:param distance:    buffer distance
-:param segments:    for round joins, number of segments to approximate quarter-circle
-:param joinStyle:   join style for corners in geometry
-:param miterLimit:  limit on the miter ratio used for very sharp corners (JoinStyleMiter only)
+:param distance: buffer distance
+:param segments: for round joins, number of segments to approximate quarter-circle
+:param joinStyle: join style for corners in geometry
+:param miterLimit: limit on the miter ratio used for very sharp corners (JoinStyleMiter only)
 
 .. versionadded:: 2.4
 %End

diff --git a/python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in b/python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in
@@ -112,7 +112,7 @@ Draws label on the right side of the item
 
 :param settings: Legend layout configuration
 :param ctx: Context for rendering - may be null if only doing layout without actual rendering
-:param symbolSize:  Real size of the associated symbol - used for correct positioning when rendering
+:param symbolSize: Real size of the associated symbol - used for correct positioning when rendering
 
 :return: Size of the label (may span multiple lines)
 %End

diff --git a/python/core/auto_generated/mesh/qgsmeshlayer.sip.in b/python/core/auto_generated/mesh/qgsmeshlayer.sip.in
@@ -91,10 +91,10 @@ The QgsMeshLayer is constructed by instantiating a data provider.  The provider
 interprets the supplied path (url) of the data source to connect to and access the
 data.
 
-:param path:  The path or url of the parameter.  Typically this encodes
+:param path: The path or url of the parameter.  Typically this encodes
              parameters used by the data provider as url query items.
 :param baseName: The name used to represent the layer in the legend
-:param providerLib:  The name of the data provider, e.g., "mesh_memory", "mdal"
+:param providerLib: The name of the data provider, e.g., "mesh_memory", "mdal"
 :param options: general mesh layer options
 %End
     ~QgsMeshLayer();

diff --git a/python/core/auto_generated/qgsaction.sip.in b/python/core/auto_generated/qgsaction.sip.in
@@ -38,25 +38,25 @@ Default constructor
 %Docstring
 Create a new QgsAction
 
-:param type:          The type of this action
-:param description:   A human readable description string
-:param command:       The action text. Its interpretation depends on the type
-:param capture:       If this is set to true, the output will be captured when an action is run
+:param type: The type of this action
+:param description: A human readable description string
+:param command: The action text. Its interpretation depends on the type
+:param capture: If this is set to true, the output will be captured when an action is run
 :param enabledOnlyWhenEditable: if true then action is only enable in editmode
 %End
 
     QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet<QString> &actionScopes = QSet<QString>(), const QString &notificationMessage = QString() );
 %Docstring
 Create a new QgsAction
 
-:param type:                 The type of this action
-:param description:          A human readable description string
-:param action:               The action text. Its interpretation depends on the type
-:param icon:                 Path to an icon for this action
-:param capture:              If this is set to true, the output will be captured when an action is run
-:param shortTitle:           A short string used to label user interface elements like buttons
-:param actionScopes:         A set of scopes in which this action will be available
-:param notificationMessage:  A particular message which reception will trigger the action
+:param type: The type of this action
+:param description: A human readable description string
+:param action: The action text. Its interpretation depends on the type
+:param icon: Path to an icon for this action
+:param capture: If this is set to true, the output will be captured when an action is run
+:param shortTitle: A short string used to label user interface elements like buttons
+:param actionScopes: A set of scopes in which this action will be available
+:param notificationMessage: A particular message which reception will trigger the action
 :param enabledOnlyWhenEditable: if true then action is only enable in editmode
 %End
 

diff --git a/python/core/auto_generated/qgsattributeeditorelement.sip.in b/python/core/auto_generated/qgsattributeeditorelement.sip.in
@@ -133,7 +133,7 @@ attribute form if it is set to the drag and drop designer.
 %Docstring
 Creates a new attribute editor container
 
-:param name:   The name to show as title
+:param name: The name to show as title
 :param parent: The parent. May be another container.
 %End
 
@@ -240,8 +240,8 @@ This element will load a field's widget onto the form.
 %Docstring
 Creates a new attribute editor element which represents a field
 
-:param name:   The name of the element
-:param idx:    The index of the field which should be embedded
+:param name: The name of the element
+:param idx: The index of the field which should be embedded
 :param parent: The parent of this widget (used as container)
 %End
 
@@ -284,16 +284,16 @@ This element will load a relation editor onto the form.
 %Docstring
 Creates a new element which embeds a relation.
 
-:param relationId:   The id of the relation to embed
-:param parent:       The parent (used as container)
+:param relationId: The id of the relation to embed
+:param parent: The parent (used as container)
 %End
 
     QgsAttributeEditorRelation( const QgsRelation &relation, QgsAttributeEditorElement *parent );
 %Docstring
 Creates a new element which embeds a relation.
 
-:param relation:     The relation to embed
-:param parent:       The parent (used as container)
+:param relation: The relation to embed
+:param parent: The parent (used as container)
 %End
 
 

diff --git a/python/core/auto_generated/qgscachedfeatureiterator.sip.in b/python/core/auto_generated/qgscachedfeatureiterator.sip.in
@@ -24,8 +24,8 @@ Delivers features from the cache
 %Docstring
 This constructor creates a feature iterator, that delivers all cached features. No request is made to the backend.
 
-:param vlCache:          The vector layer cache to use
-:param featureRequest:   The feature request to answer
+:param vlCache: The vector layer cache to use
+:param featureRequest: The feature request to answer
 %End
 
     virtual bool rewind();
@@ -51,7 +51,7 @@ Close this iterator. No further features will be available.
 %Docstring
 Implementation for fetching a feature.
 
-:param f:      Will write to this feature
+:param f: Will write to this feature
 
 :return: bool  true if the operation was OK
 
@@ -62,7 +62,7 @@ Implementation for fetching a feature.
 %Docstring
 We have a local special iterator for FilterFids, no need to run the generic.
 
-:param f:      Will write to this feature
+:param f: Will write to this feature
 
 :return: bool  true if the operation was OK
 %End
@@ -84,8 +84,8 @@ Uses another iterator as backend and writes features to the cache
 %Docstring
 This constructor creates a feature iterator, which queries the backend and caches retrieved features.
 
-:param vlCache:          The vector layer cache to use
-:param featureRequest:   The feature request to answer
+:param vlCache: The vector layer cache to use
+:param featureRequest: The feature request to answer
 %End
 
     virtual bool rewind();
@@ -111,7 +111,7 @@ Close this iterator. No further features will be available.
 %Docstring
 Implementation for fetching a feature.
 
-:param f:      Will write to this feature
+:param f: Will write to this feature
 
 :return: bool  true if the operation was OK
 

diff --git a/python/core/auto_generated/qgscacheindex.sip.in b/python/core/auto_generated/qgscacheindex.sip.in
@@ -45,8 +45,8 @@ Implement this method to update the the indices, in case you need information co
 to properly index. (E.g. spatial index)
 Does nothing by default
 
-:param featureRequest:  The feature request that was answered
-:param fids:            The feature ids that have been returned
+:param featureRequest: The feature request that was answered
+:param fids: The feature ids that have been returned
 %End
 
     virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0;
@@ -56,10 +56,10 @@ If this cache index is able to completely answer the feature request, it will re
 and set the iterator to a valid iterator over the cached features. If it is not able
 it will return false.
 
-:param featureIterator:  A reference to a :py:class:`QgsFeatureIterator`. A valid featureIterator will
+:param featureIterator: A reference to a :py:class:`QgsFeatureIterator`. A valid featureIterator will
                         be assigned in case this index is able to answer the request and the return
                         value is true.
-:param featureRequest:   The feature request, for which this index is queried.
+:param featureRequest: The feature request, for which this index is queried.
 
 :return:   True, if this index holds the information to answer the request.
 %End

diff --git a/python/core/auto_generated/qgseditformconfig.sip.in b/python/core/auto_generated/qgseditformconfig.sip.in
@@ -135,8 +135,8 @@ Example:
        editFormConfig.setWidgetConfig( 'relation_id', { 'nm-rel': 'other_relation' } )
        layer.setEditFormConfig(editFormConfig)
 
-:param widgetName:  The name of the widget to configure
-:param config:      The config to set for this widget
+:param widgetName: The name of the widget to configure
+:param config: The config to set for this widget
 
 :return: false if a field exists with the provided widgetName. In this case
          QgsVectorLayer.setEditorWidgetSetup should be used.

diff --git a/python/core/auto_generated/qgsexpressionfieldbuffer.sip.in b/python/core/auto_generated/qgsexpressionfieldbuffer.sip.in
@@ -55,7 +55,7 @@ Remove an expression from the buffer
 Renames an expression field at a given index
 
 :param index: The index of the expression to change
-:param name:   New name for field
+:param name: New name for field
 
 .. versionadded:: 3.0
 %End
@@ -65,7 +65,7 @@ Renames an expression field at a given index
 Changes the expression at a given index
 
 :param index: The index of the expression to change
-:param exp:   The new expression to set
+:param exp: The new expression to set
 
 .. versionadded:: 2.9
 %End

diff --git a/python/core/auto_generated/qgsfeaturerequest.sip.in b/python/core/auto_generated/qgsfeaturerequest.sip.in
@@ -116,7 +116,7 @@ from the provider.
 Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                   If the order is ascending, by default nulls are last
                   If the order is descending, by default nulls are first
 %End
@@ -126,7 +126,7 @@ Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
 :param nullsfirst: If true, NULLS are at the beginning, if false, NULLS are at the end
 %End
 
@@ -135,7 +135,7 @@ Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                   If the order is ascending, by default nulls are last
                   If the order is descending, by default nulls are first
 %End
@@ -145,7 +145,7 @@ Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
 :param nullsfirst: If true, NULLS are at the beginning, if false, NULLS are at the end
 %End
 
@@ -448,7 +448,7 @@ The spatial filter (filterRect) will be kept in place.
 Adds a new OrderByClause, appending it as the least important one.
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                   If the order is ascending, by default nulls are last
                   If the order is descending, by default nulls are first
 
@@ -460,7 +460,7 @@ Adds a new OrderByClause, appending it as the least important one.
 Adds a new OrderByClause, appending it as the least important one.
 
 :param expression: The expression to use for ordering
-:param ascending:  If the order should be ascending (1,2,3) or descending (3,2,1)
+:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
 :param nullsfirst: If true, NULLS are at the beginning, if false, NULLS are at the end
 
 .. versionadded:: 2.14
@@ -627,7 +627,7 @@ called using the feature which encountered the transform error as a parameter.
 %Docstring
 Check if a feature is accepted by this requests filter
 
-:param feature:  The feature which will be tested
+:param feature: The feature which will be tested
 
 :return: true, if the filter accepts the feature
 

diff --git a/python/core/auto_generated/qgsfield.sip.in b/python/core/auto_generated/qgsfield.sip.in
@@ -257,7 +257,7 @@ Formats string for display
 %Docstring
 Converts the provided variant to a compatible format
 
-:param v:  The value to convert
+:param v: The value to convert
 
 :return:   True if the conversion was successful
 %End
@@ -317,7 +317,7 @@ Converts the provided variant to a compatible format
 %Docstring
 Set the editor widget setup for the field.
 
-:param v:  The value to set
+:param v: The value to set
 %End
 
     QgsEditorWidgetSetup editorWidgetSetup() const;

diff --git a/python/core/auto_generated/qgsfields.sip.in b/python/core/auto_generated/qgsfields.sip.in
@@ -119,7 +119,7 @@ Returns a list with field names
 %Docstring
 Returns if a field index is valid
 
-:param i:  Index of the field which needs to be checked
+:param i: Index of the field which needs to be checked
 
 :return:   True if the field exists
 %End

diff --git a/python/core/auto_generated/qgsmaplayerstore.sip.in b/python/core/auto_generated/qgsmaplayerstore.sip.in
@@ -287,7 +287,7 @@ Emitted when a layer is about to be removed from the store.
 %Docstring
 Emitted after one or more layers were removed from the store.
 
-:param layerIds:  A list of IDs of the layers which were removed.
+:param layerIds: A list of IDs of the layers which were removed.
 
 .. seealso:: :py:func:`layersWillBeRemoved`
 %End