Skip to content
Permalink
Browse files

[pyqgis] Ensure that multiline param tags are indented for additional…

… lines
  • Loading branch information
nyalldawson committed May 24, 2018
1 parent c864d22 commit 38850bdb94afff3c4291460eb1b492c7c85a949b
Showing with 600 additions and 576 deletions.
  1. +1 −1 python/analysis/auto_generated/network/qgsgraph.sip.in
  2. +1 −1 python/analysis/auto_generated/network/qgsgraphanalyzer.sip.in
  3. +1 −1 python/analysis/auto_generated/network/qgsnetworkdistancestrategy.sip.in
  4. +1 −1 python/analysis/auto_generated/network/qgsnetworkspeedstrategy.sip.in
  5. +1 −1 python/analysis/auto_generated/network/qgsnetworkstrategy.sip.in
  6. +2 −2 python/analysis/auto_generated/network/qgsvectorlayerdirector.sip.in
  7. +1 −1 python/analysis/auto_generated/processing/qgsnativealgorithms.sip.in
  8. +1 −1 python/core/auto_generated/auth/qgsauthcertutils.sip.in
  9. +1 −1 python/core/auto_generated/auth/qgsauthmanager.sip.in
  10. +4 −4 python/core/auto_generated/auth/qgsauthmethod.sip.in
  11. +6 −6 python/core/auto_generated/effects/qgsblureffect.sip.in
  12. +16 −16 python/core/auto_generated/effects/qgscoloreffect.sip.in
  13. +4 −4 python/core/auto_generated/effects/qgseffectstack.sip.in
  14. +7 −7 python/core/auto_generated/effects/qgsgloweffect.sip.in
  15. +8 −8 python/core/auto_generated/effects/qgsimageoperation.sip.in
  16. +4 −4 python/core/auto_generated/effects/qgspainteffect.sip.in
  17. +2 −2 python/core/auto_generated/effects/qgspainteffectregistry.sip.in
  18. +7 −7 python/core/auto_generated/effects/qgsshadoweffect.sip.in
  19. +2 −2 python/core/auto_generated/expression/qgsexpression.sip.in
  20. +8 −8 python/core/auto_generated/geometry/qgsabstractgeometry.sip.in
  21. +24 −24 python/core/auto_generated/geometry/qgsgeometry.sip.in
  22. +3 −3 python/core/auto_generated/geometry/qgsgeometryutils.sip.in
  23. +6 −6 python/core/auto_generated/geometry/qgslinestring.sip.in
  24. +1 −1 python/core/auto_generated/geometry/qgspoint.sip.in
  25. +18 −18 python/core/auto_generated/geometry/qgstriangle.sip.in
  26. +3 −3 python/core/auto_generated/layout/qgslayoutitemattributetable.sip.in
  27. +1 −1 python/core/auto_generated/layout/qgslayoutitemhtml.sip.in
  28. +1 −1 python/core/auto_generated/layout/qgslayoutitemlegend.sip.in
  29. +5 −5 python/core/auto_generated/layout/qgslayoutitemmap.sip.in
  30. +3 −3 python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in
  31. +5 −5 python/core/auto_generated/layout/qgslayoutmultiframe.sip.in
  32. +3 −3 python/core/auto_generated/layout/qgslayouttable.sip.in
  33. +2 −2 python/core/auto_generated/layout/qgslayoututils.sip.in
  34. +3 −3 python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in
  35. +1 −1 python/core/auto_generated/qgsbrowsermodel.sip.in
  36. +1 −1 python/core/auto_generated/qgscacheindex.sip.in
  37. +6 −6 python/core/auto_generated/qgscolorramp.sip.in
  38. +1 −1 python/core/auto_generated/qgscolorscheme.sip.in
  39. +2 −2 python/core/auto_generated/qgsconditionalstyle.sip.in
  40. +6 −6 python/core/auto_generated/qgscoordinatereferencesystem.sip.in
  41. +3 −3 python/core/auto_generated/qgscoordinatetransform.sip.in
  42. +4 −4 python/core/auto_generated/qgsdistancearea.sip.in
  43. +1 −1 python/core/auto_generated/qgseditformconfig.sip.in
  44. +3 −3 python/core/auto_generated/qgsexpressioncontext.sip.in
  45. +2 −2 python/core/auto_generated/qgsfeature.sip.in
  46. +1 −1 python/core/auto_generated/qgsfeaturefilterprovider.sip.in
  47. +6 −6 python/core/auto_generated/qgsfeaturerequest.sip.in
  48. +6 −6 python/core/auto_generated/qgsfield.sip.in
  49. +3 −3 python/core/auto_generated/qgsfiledownloader.sip.in
  50. +2 −2 python/core/auto_generated/qgsfontutils.sip.in
  51. +6 −6 python/core/auto_generated/qgsjsonutils.sip.in
  52. +29 −29 python/core/auto_generated/qgsmaplayer.sip.in
  53. +5 −5 python/core/auto_generated/qgsmaplayerstore.sip.in
  54. +6 −6 python/core/auto_generated/qgsmaprendererjob.sip.in
  55. +1 −1 python/core/auto_generated/qgsmapunitscale.sip.in
  56. +4 −4 python/core/auto_generated/qgsmultirenderchecker.sip.in
  57. +5 −5 python/core/auto_generated/qgsogcutils.sip.in
  58. +6 −6 python/core/auto_generated/qgspallabeling.sip.in
  59. +7 −7 python/core/auto_generated/qgsproject.sip.in
  60. +4 −4 python/core/auto_generated/qgsproperty.sip.in
  61. +20 −20 python/core/auto_generated/qgspropertycollection.sip.in
  62. +15 −15 python/core/auto_generated/qgspropertytransformer.sip.in
  63. +7 −7 python/core/auto_generated/qgsrenderchecker.sip.in
  64. +1 −1 python/core/auto_generated/qgsruntimeprofiler.sip.in
  65. +2 −2 python/core/auto_generated/qgsscaleutils.sip.in
  66. +1 −1 python/core/auto_generated/qgsstatisticalsummary.sip.in
  67. +1 −1 python/core/auto_generated/qgsstringutils.sip.in
  68. +21 −21 python/core/auto_generated/qgstextrenderer.sip.in
  69. +2 −2 python/core/auto_generated/qgsunittypes.sip.in
  70. +2 −2 python/core/auto_generated/qgsvectordataprovider.sip.in
  71. +3 −3 python/core/auto_generated/qgsvectorfilewriter.sip.in
  72. +61 −61 python/core/auto_generated/qgsvectorlayer.sip.in
  73. +26 −26 python/core/auto_generated/qgsvectorlayereditutils.sip.in
  74. +2 −2 python/core/auto_generated/qgsvectorlayerexporter.sip.in
  75. +6 −6 python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
  76. +1 −1 python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in
  77. +1 −1 python/core/auto_generated/symbology/qgsgeometrygeneratorsymbollayer.sip.in
  78. +2 −2 python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in
  79. +4 −4 python/core/auto_generated/symbology/qgsheatmaprenderer.sip.in
  80. +4 −4 python/core/auto_generated/symbology/qgsinvertedpolygonrenderer.sip.in
  81. +1 −1 python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
  82. +1 −1 python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in
  83. +6 −6 python/core/auto_generated/symbology/qgsrenderer.sip.in
  84. +2 −2 python/core/auto_generated/symbology/qgsrendererregistry.sip.in
  85. +1 −1 python/core/auto_generated/symbology/qgsrulebasedrenderer.sip.in
  86. +1 −1 python/core/auto_generated/symbology/qgsstyle.sip.in
  87. +7 −7 python/core/auto_generated/symbology/qgssymbol.sip.in
  88. +2 −2 python/core/auto_generated/symbology/qgssymbollayer.sip.in
  89. +2 −2 python/core/auto_generated/symbology/qgssymbollayerutils.sip.in
  90. +1 −1 python/gui/auto_generated/attributetable/qgsattributetableview.sip.in
  91. +4 −4 python/gui/auto_generated/attributetable/qgsdualview.sip.in
  92. +2 −2 python/gui/auto_generated/attributetable/qgsfeaturelistmodel.sip.in
  93. +4 −4 python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
  94. +4 −4 python/gui/auto_generated/effects/qgseffectstackpropertieswidget.sip.in
  95. +1 −1 python/gui/auto_generated/layout/qgslayoutitemcombobox.sip.in
  96. +1 −1 python/gui/auto_generated/qgisinterface.sip.in
  97. +2 −2 python/gui/auto_generated/qgsactionmenu.sip.in
  98. +1 −1 python/gui/auto_generated/qgsattributedialog.sip.in
  99. +1 −1 python/gui/auto_generated/qgsattributeeditorcontext.sip.in
  100. +1 −1 python/gui/auto_generated/qgsattributeformeditorwidget.sip.in
  101. +1 −1 python/gui/auto_generated/qgscheckablecombobox.sip.in
  102. +5 −5 python/gui/auto_generated/qgscolorbutton.sip.in
  103. +3 −3 python/gui/auto_generated/qgscolorrampbutton.sip.in
  104. +2 −2 python/gui/auto_generated/qgscolorswatchgrid.sip.in
  105. +9 −9 python/gui/auto_generated/qgscolorwidgets.sip.in
  106. +1 −1 python/gui/auto_generated/qgsconfigureshortcutsdialog.sip.in
  107. +8 −8 python/gui/auto_generated/qgsdockwidget.sip.in
  108. +1 −1 python/gui/auto_generated/qgsencodingfiledialog.sip.in
  109. +2 −2 python/gui/auto_generated/qgsexpressionlineedit.sip.in
  110. +2 −2 python/gui/auto_generated/qgsextentgroupbox.sip.in
  111. +2 −2 python/gui/auto_generated/qgsfieldexpressionwidget.sip.in
  112. +1 −1 python/gui/auto_generated/qgsfilterlineedit.sip.in
  113. +1 −1 python/gui/auto_generated/qgsfocuswatcher.sip.in
  114. +3 −3 python/gui/auto_generated/qgsmapcanvas.sip.in
  115. +1 −1 python/gui/auto_generated/qgsmaplayerconfigwidgetfactory.sip.in
  116. +3 −3 python/gui/auto_generated/qgsmaptip.sip.in
  117. +1 −1 python/gui/auto_generated/qgsmaptoolextent.sip.in
  118. +1 −1 python/gui/auto_generated/qgsoptionsdialoghighlightwidget.sip.in
  119. +2 −2 python/gui/auto_generated/qgspanelwidget.sip.in
  120. +1 −1 python/gui/auto_generated/qgspasswordlineedit.sip.in
  121. +2 −2 python/gui/auto_generated/qgsprojectionselectiondialog.sip.in
  122. +2 −2 python/gui/auto_generated/qgsprojectionselectiontreewidget.sip.in
  123. +2 −2 python/gui/auto_generated/qgsrubberband.sip.in
  124. +7 −7 python/gui/auto_generated/qgsshortcutsmanager.sip.in
  125. +1 −1 python/gui/auto_generated/qgstreewidgetitem.sip.in
  126. +1 −1 python/gui/auto_generated/qgsvariableeditorwidget.sip.in
  127. +1 −1 python/gui/auto_generated/symbology/qgsgraduatedhistogramwidget.sip.in
  128. +1 −1 python/gui/auto_generated/symbology/qgsrendererpropertiesdialog.sip.in
  129. +1 −1 python/gui/auto_generated/symbology/qgssymbollayerwidget.sip.in
  130. +1 −1 python/server/auto_generated/qgsfeaturefilter.sip.in
  131. +1 −1 python/server/auto_generated/qgsfeaturefilterprovidergroup.sip.in
  132. +1 −1 python/server/auto_generated/qgsserver.sip.in
  133. +25 −1 scripts/sipify.pl
@@ -16,7 +16,7 @@ class QgsGraphEdge
%Docstring

.. versionadded:: 3.0
This class implements a graph edge
This class implements a graph edge
%End

%TypeHeaderCode
@@ -31,7 +31,7 @@ Solve shortest path problem using Dijkstra algorithm
:param startVertexIdx: index of the start vertex
:param criterionNum: index of the optimization strategy
:param resultTree: array that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1.
Note that the startVertexIdx will also have a value of -1 and may need special handling by callers.
Note that the startVertexIdx will also have a value of -1 and may need special handling by callers.
:param resultCost: array of the paths costs
%End

@@ -13,7 +13,7 @@ class QgsNetworkDistanceStrategy : QgsNetworkStrategy
%Docstring

.. versionadded:: 3.0
Strategy for caclulating edge cost based on its length. Should be
Strategy for caclulating edge cost based on its length. Should be
used for finding shortest path between two points.
%End

@@ -13,7 +13,7 @@ class QgsNetworkSpeedStrategy : QgsNetworkStrategy
%Docstring

.. versionadded:: 3.0
Strategy for calculating edge cost based on travel time. Should be
Strategy for calculating edge cost based on travel time. Should be
used for finding fastest path between two points.
%End

@@ -20,7 +20,7 @@ class QgsNetworkStrategy
%Docstring

.. versionadded:: 3.0
QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
take into account travel distance, amount of time or money. Currently there are two strategies
implemented in the analysis library: QgsNetworkDistanceStrategy and QgsNetworkSpeedStrategy.
QgsNetworkStrategy implemented using "strategy" design pattern.
@@ -15,7 +15,7 @@ class QgsVectorLayerDirector : QgsGraphDirector
%Docstring

.. versionadded:: 3.0
Determine making the graph from vector line layer
Determine making the graph from vector line layer
%End

%TypeHeaderCode
@@ -46,7 +46,7 @@ Default constructor
:param reverseDirectionValue: value for reversed one-way road
:param bothDirectionValue: value for two-way (bidirectional) road
:param defaultDirection: default direction. Will be used if corresponding
attribute value is not set or does not equal to the given values
attribute value is not set or does not equal to the given values
%End

virtual void makeGraph( QgsGraphBuilderInterface *builder,
@@ -14,7 +14,7 @@ class QgsNativeAlgorithms: QgsProcessingProvider
%Docstring

.. versionadded:: 3.0
Native c++ processing algorithm provider.
Native c++ processing algorithm provider.
%End

%TypeHeaderCode
@@ -331,7 +331,7 @@ expiration and effective dates, optionally trusts the root CA
:param bundle:
:param useIntermediates: if true the intermediate certs are also checked
:param trustRootCa: if true the CA will be added to the trusted CAs for this validation check (if useIntermediates is false)
this option is ignored and set to false
this option is ignored and set to false

:return: a list of error strings, if the list is empty then the PKI bundle is valid
%End
@@ -165,7 +165,7 @@ Re-emit a signal to schedule an optional erase of authentication database.
processing state is not ready for interacting with the user, e.g. project is still loading

:param emitted: Setting to false will cause signal to be emitted by the schedule timer.
Setting to true will stop any emitting, but will not stop the schedule timer.
Setting to true will stop any emitting, but will not stop the schedule timer.
%End

QString authManTag() const;
@@ -78,7 +78,7 @@ Update a network request with authentication components
:param request: The network request to update
:param authcfg: Authentication configuration ID
:param dataprovider: Textual key for a data provider, e.g. 'postgres', that allows
for custom updater code specific to the provider
for custom updater code specific to the provider

:return: Whether the update succeeded
%End
@@ -91,7 +91,7 @@ Update a network reply with authentication components
:param reply: The network reply object to update
:param authcfg: Authentication configuration ID
:param dataprovider: Textual key for a data provider, e.g. 'postgres', that allows
for custom updater code specific to the provider
for custom updater code specific to the provider

:return: Whether the update succeeded
%End
@@ -104,7 +104,7 @@ Update data source connection items with authentication components
:param connectionItems: QStringlist of 'key=value' pairs, as utilized in :py:func:`QgsDataSourceUri.connectionInfo()`
:param authcfg: Authentication configuration ID
:param dataprovider: Textual key for a data provider, e.g. 'postgres', that allows
for custom updater code specific to the provider
for custom updater code specific to the provider

:return: Whether the update succeeded
%End
@@ -117,7 +117,7 @@ Update proxy settings with authentication components
:param proxy:
:param authcfg: Authentication configuration ID
:param dataprovider: Textual key for a data provider, e.g. 'proxy', that allows
for custom updater code specific to the provider
for custom updater code specific to the provider

:return: Whether the update succeeded
%End
@@ -56,7 +56,7 @@ Constructor for QgsBlurEffect.
Sets blur level (strength)

:param level: blur level. Depending on the current blurMethod(), this parameter
has different effects
has different effects

.. seealso:: :py:func:`blurLevel`

@@ -68,7 +68,7 @@ has different effects
Returns the blur level (strength)

:return: blur level. Depending on the current blurMethod(), this parameter
has different effects
has different effects

.. seealso:: :py:func:`setBlurLevel`

@@ -98,7 +98,7 @@ Returns the blur method (algorithm) used for performing the blur.
Sets the ``opacity`` for the effect.

:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
and 1 is fully opaque

.. seealso:: :py:func:`opacity`
%End
@@ -108,7 +108,7 @@ and 1 is fully opaque
Returns the opacity for the effect.

:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
and 1 is fully opaque

.. seealso:: :py:func:`setOpacity`
%End
@@ -118,7 +118,7 @@ and 1 is fully opaque
Sets the blend mode for the effect

:param mode: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`blendMode`
%End
@@ -128,7 +128,7 @@ paint device
Returns the blend mode for the effect

:return: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`setBlendMode`
%End
@@ -47,8 +47,8 @@ Creates a new QgsColorEffect effect from a properties string map.
Sets the brightness modification for the effect.

:param brightness: Valid values are between -255 and 255, where 0 represents
no change, negative values indicate darkening and positive values indicate
lightening
no change, negative values indicate darkening and positive values indicate
lightening

.. seealso:: :py:func:`setBrightness`
%End
@@ -58,8 +58,8 @@ lightening
Returns the brightness modification for the effect.

:return: brightness value. Values are between -255 and 255, where 0 represents
no change, negative values indicate darkening and positive values indicate
lightening
no change, negative values indicate darkening and positive values indicate
lightening

.. seealso:: :py:func:`setBrightness`
%End
@@ -69,8 +69,8 @@ lightening
Sets the contrast modification for the effect.

:param contrast: Valid values are between -100 and 100, where 0 represents
no change, negative values indicate less contrast and positive values indicate
greater contrast
no change, negative values indicate less contrast and positive values indicate
greater contrast

.. seealso:: :py:func:`setContrast`
%End
@@ -80,8 +80,8 @@ greater contrast
Returns the contrast modification for the effect.

:return: contrast value. Values are between -100 and 100, where 0 represents
no change, negative values indicate less contrast and positive values indicate
greater contrast
no change, negative values indicate less contrast and positive values indicate
greater contrast

.. seealso:: :py:func:`setContrast`
%End
@@ -91,8 +91,8 @@ greater contrast
Sets the saturation modification for the effect.

:param saturation: Valid values are between 0 and 2.0, where 1.0 represents
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation

.. seealso:: :py:func:`saturation`
%End
@@ -102,8 +102,8 @@ greater saturation
Returns the saturation modification for the effect.

:return: saturation value. Values are between 0 and 2.0, where 1.0 represents
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation

.. seealso:: :py:func:`setSaturation`
%End
@@ -213,7 +213,7 @@ setColorizeOn() is set to true.
Sets the ``opacity`` for the effect.

:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
and 1 is fully opaque

.. seealso:: :py:func:`opacity`
%End
@@ -223,7 +223,7 @@ and 1 is fully opaque
Returns the opacity for the effect.

:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque.
and 1 is fully opaque.

.. seealso:: :py:func:`setOpacity`
%End
@@ -233,7 +233,7 @@ and 1 is fully opaque.
Sets the blend mode for the effect

:param mode: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`blendMode`
%End
@@ -243,7 +243,7 @@ paint device
Returns the blend mode for the effect

:return: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`setBlendMode`
%End
@@ -56,7 +56,7 @@ Constructor for empty QgsEffectStack.
Creates a new QgsEffectStack effect from a single initial effect.

:param effect: initial effect to add to the stack. The effect will
be cloned, so ownership is not transferred to the stack.
be cloned, so ownership is not transferred to the stack.

:return: new QgsEffectStack containing initial effect
%End
@@ -88,7 +88,7 @@ Unused for QgsEffectStack, props parameter will be ignored
Appends an effect to the end of the stack.

:param effect: QgsPaintEffect to append. Ownership of the effect will be
transferred to the stack object.
transferred to the stack object.

.. seealso:: :py:func:`insertEffect`
%End
@@ -99,7 +99,7 @@ Inserts an effect at a specified index within the stack.

:param index: position to insert the effect
:param effect: QgsPaintEffect to insert. Ownership of the effect will be
transferred to the stack object.
transferred to the stack object.

.. seealso:: :py:func:`appendEffect`
%End
@@ -110,7 +110,7 @@ Replaces the effect at a specified position within the stack.

:param index: position of effect to replace
:param effect: QgsPaintEffect to replace with. Ownership of the effect will be
transferred to the stack object.
transferred to the stack object.
%End

QgsPaintEffect *takeEffect( const int index /TransferBack/ );
@@ -124,7 +124,7 @@ Sets blur level (strength) for the glow. This can be used to smooth the
output from the glow effect.

:param level: blur level. Values between 0 and 16 are valid, with larger
values indicating greater blur strength.
values indicating greater blur strength.

.. seealso:: :py:func:`blurLevel`
%End
@@ -134,7 +134,7 @@ values indicating greater blur strength.
Returns the blur level (strength) for the glow.

:return: blur level. Value will be between 0 and 16, with larger
values indicating greater blur strength.
values indicating greater blur strength.

.. seealso:: :py:func:`setBlurLevel`
%End
@@ -144,7 +144,7 @@ values indicating greater blur strength.
Sets the ``opacity`` for the effect.

:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
and 1 is fully opaque

.. seealso:: :py:func:`opacity`
%End
@@ -154,7 +154,7 @@ and 1 is fully opaque
Returns the opacity for the effect.

:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
and 1 is fully opaque

.. seealso:: :py:func:`setOpacity`
%End
@@ -214,7 +214,7 @@ is set to ColorRamp. The glow will utilize colors from the ramp.
Sets the blend mode for the effect

:param mode: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`blendMode`
%End
@@ -224,7 +224,7 @@ paint device
Returns the blend mode for the effect

:return: blend mode used for drawing the effect on to a destination
paint device
paint device

.. seealso:: :py:func:`setBlendMode`
%End
@@ -272,7 +272,7 @@ Specifies whether the glow is drawn outside the picture or within
the picture.

:return: true if glow is to be drawn outside the picture, or false
to draw glow within the picture
to draw glow within the picture
%End


0 comments on commit 38850bd

Please sign in to comment.
You can’t perform that action at this time.