Merge pull request #42390 from 3nids/sipify-docstring-class-append

[pyqgis] move constructor docstring after the class docstring
qgis · Mar 22, 2021 · 1ba9dcad1d084300769f13cf0035546e137829a8 · 1ba9dca
2 parents 97dced9 + 8c2cb9c
commit 1ba9dcad1d084300769f13cf0035546e137829a8
Unified Split

Showing 1,067 changed files with 1,550 additions and 1,550 deletions.
diff --git a/python/3d/auto_generated/materials/qgsabstractmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsabstractmaterialsettings.sip.in
@@ -25,7 +25,7 @@ enum class QgsMaterialSettingsRenderingTechnique
 
 class QgsMaterialContext
 {
-%Docstring
+%Docstring(signature="appended")
 Context settings for a material.
 
 .. warning::
@@ -74,7 +74,7 @@ Sets the color for representing materials in a selected state.
 
 class QgsAbstractMaterialSettings /Abstract/
 {
-%Docstring
+%Docstring(signature="appended")
 Abstract base class for material settings.
 
 .. warning::

diff --git a/python/3d/auto_generated/materials/qgsgoochmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsgoochmaterialsettings.sip.in
@@ -12,7 +12,7 @@
 
 class QgsGoochMaterialSettings : QgsAbstractMaterialSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Basic shading material used for rendering based on the Phong shading model
 with three color components: ambient, diffuse and specular.
 

diff --git a/python/3d/auto_generated/materials/qgsmaterialregistry.sip.in b/python/3d/auto_generated/materials/qgsmaterialregistry.sip.in
@@ -13,7 +13,7 @@ class QgsMaterialSettingsWidget /External/;
 
 class QgsMaterialSettingsAbstractMetadata
 {
-%Docstring
+%Docstring(signature="appended")
 Stores metadata about one 3D material settings class.
 
 .. note::
@@ -75,7 +75,7 @@ Returns ``True`` if the material type supports the specified rendering ``techniq
 
 class QgsMaterialRegistry
 {
-%Docstring
+%Docstring(signature="appended")
 Registry of available 3d material settings classes.
 
 :py:class:`QgsMaterialRegistry` is not usually directly created, but rather accessed through

diff --git a/python/3d/auto_generated/materials/qgsnullmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsnullmaterialsettings.sip.in
@@ -13,7 +13,7 @@
 
 class QgsNullMaterialSettings : QgsAbstractMaterialSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Null shading material used for rendering models and scenes with native textures.
 
 .. warning::

diff --git a/python/3d/auto_generated/materials/qgsphongmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsphongmaterialsettings.sip.in
@@ -13,7 +13,7 @@
 
 class QgsPhongMaterialSettings : QgsAbstractMaterialSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Basic shading material used for rendering based on the Phong shading model
 with three color components: ambient, diffuse and specular.
 

diff --git a/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in
@@ -12,7 +12,7 @@
 
 class QgsPhongTexturedMaterialSettings : QgsAbstractMaterialSettings
 {
-%Docstring
+%Docstring(signature="appended")
 A phong shading model with diffuse texture map.
 
 .. warning::

diff --git a/python/3d/auto_generated/materials/qgssimplelinematerialsettings.sip.in b/python/3d/auto_generated/materials/qgssimplelinematerialsettings.sip.in
@@ -13,7 +13,7 @@
 
 class QgsSimpleLineMaterialSettings : QgsAbstractMaterialSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Basic shading material used for rendering simple lines as solid line components.
 
 .. warning::

diff --git a/python/3d/auto_generated/processing/qgs3dalgorithms.sip.in b/python/3d/auto_generated/processing/qgs3dalgorithms.sip.in
@@ -11,7 +11,7 @@
 
 class Qgs3DAlgorithms: QgsProcessingProvider
 {
-%Docstring
+%Docstring(signature="appended")
 QGIS 3D processing algorithm provider.
 
 .. versionadded:: 3.0

diff --git a/python/3d/auto_generated/qgs3d.sip.in b/python/3d/auto_generated/qgs3d.sip.in
@@ -12,7 +12,7 @@
 
 class Qgs3D
 {
-%Docstring
+%Docstring(signature="appended")
 Qgs3D is a singleton class containing various registries and other global members
 related to 3D classes.
 

diff --git a/python/3d/auto_generated/qgs3dmapexportsettings.sip.in b/python/3d/auto_generated/qgs3dmapexportsettings.sip.in
@@ -11,7 +11,7 @@
 
 class Qgs3DMapExportSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Manages the various settings the user can choose from when exporting a 3D scene
 
 .. versionadded:: 3.16

diff --git a/python/3d/auto_generated/qgs3dmapsettings.sip.in b/python/3d/auto_generated/qgs3dmapsettings.sip.in
@@ -17,7 +17,7 @@
 
 class Qgs3DMapSettings : QObject, QgsTemporalRangeObject
 {
-%Docstring
+%Docstring(signature="appended")
 Definition of the world.
 
 .. versionadded:: 3.0

diff --git a/python/3d/auto_generated/qgs3dtypes.sip.in b/python/3d/auto_generated/qgs3dtypes.sip.in
@@ -10,7 +10,7 @@
 
 class Qgs3DTypes
 {
-%Docstring
+%Docstring(signature="appended")
 Defines enumerations and other auxiliary types for QGIS 3D
 
 .. warning::

diff --git a/python/3d/auto_generated/qgsabstractvectorlayer3drenderer.sip.in b/python/3d/auto_generated/qgsabstractvectorlayer3drenderer.sip.in
@@ -12,7 +12,7 @@
 
 class QgsVectorLayer3DTilingSettings
 {
-%Docstring
+%Docstring(signature="appended")
 This class defines configuration of how a vector layer gets tiled for 3D rendering.
 
 Zoom levels count tells how deep will be the quadtree and thus how many tiles will
@@ -64,7 +64,7 @@ Reads content of the object from XML
 
 class QgsAbstractVectorLayer3DRenderer : QgsAbstract3DRenderer /Abstract/
 {
-%Docstring
+%Docstring(signature="appended")
 Base class for 3D renderers that are based on vector layers.
 
 .. versionadded:: 3.12

diff --git a/python/3d/auto_generated/qgscamerapose.sip.in b/python/3d/auto_generated/qgscamerapose.sip.in
@@ -13,7 +13,7 @@
 
 class QgsCameraPose
 {
-%Docstring
+%Docstring(signature="appended")
 Class that encapsulates camera pose in a 3D scene.
 
 The pose is defined with the following parameters:

diff --git a/python/3d/auto_generated/qgsdirectionallightsettings.sip.in b/python/3d/auto_generated/qgsdirectionallightsettings.sip.in
@@ -11,7 +11,7 @@
 
 class QgsDirectionalLightSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Definition of a directional light in a 3D map scene
 
 .. versionadded:: 3.16

diff --git a/python/3d/auto_generated/qgslayoutitem3dmap.sip.in b/python/3d/auto_generated/qgslayoutitem3dmap.sip.in
@@ -18,7 +18,7 @@
 
 class QgsLayoutItem3DMap : QgsLayoutItem, QgsTemporalRangeObject
 {
-%Docstring
+%Docstring(signature="appended")
 
 Implements support of 3D map views in print layouts
 

diff --git a/python/3d/auto_generated/qgspointcloudlayer3drenderer.sip.in b/python/3d/auto_generated/qgspointcloudlayer3drenderer.sip.in
@@ -14,7 +14,7 @@
 
 class QgsPointCloudLayer3DRenderer : QgsAbstract3DRenderer
 {
-%Docstring
+%Docstring(signature="appended")
 3D renderer that renders all points from a point cloud layer
 
 .. versionadded:: 3.18

diff --git a/python/3d/auto_generated/qgspointlightsettings.sip.in b/python/3d/auto_generated/qgspointlightsettings.sip.in
@@ -12,7 +12,7 @@
 
 class QgsPointLightSettings
 {
-%Docstring
+%Docstring(signature="appended")
 Definition of a point light in a 3D map scene
 
 Total light at the distance D from a point light with intensity I

diff --git a/python/3d/auto_generated/qgsrulebased3drenderer.sip.in b/python/3d/auto_generated/qgsrulebased3drenderer.sip.in
@@ -13,7 +13,7 @@
 
 class QgsRuleBased3DRendererMetadata : Qgs3DRendererAbstractMetadata
 {
-%Docstring
+%Docstring(signature="appended")
 Metadata for rule-based 3D renderer to allow creation of its instances from XML
 
 .. warning::
@@ -40,7 +40,7 @@ Creates an instance of a 3D renderer based on a DOM element with renderer config
 
 class QgsRuleBased3DRenderer : QgsAbstractVectorLayer3DRenderer
 {
-%Docstring
+%Docstring(signature="appended")
 Rule-based 3D renderer.
 
 Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols.
@@ -63,7 +63,7 @@ Similar to rule-based 2D renderer and rule-based labeling, it allows specificati
 
     class Rule
 {
-%Docstring
+%Docstring(signature="appended")
 A child rule for a QgsRuleBased3DRenderer
 
 .. versionadded:: 3.6

diff --git a/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in b/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in
@@ -15,7 +15,7 @@
 
 class QgsVectorLayer3DRendererMetadata : Qgs3DRendererAbstractMetadata
 {
-%Docstring
+%Docstring(signature="appended")
 Metadata for vector layer 3D renderer to allow creation of its instances from XML.
 
 .. warning::
@@ -42,7 +42,7 @@ Creates an instance of a 3D renderer based on a DOM element with renderer config
 
 class QgsVectorLayer3DRenderer : QgsAbstractVectorLayer3DRenderer
 {
-%Docstring
+%Docstring(signature="appended")
 3D renderer that renders all features of a vector layer with the same 3D symbol.
 The appearance is completely defined by the symbol.
 

diff --git a/python/3d/auto_generated/symbols/qgsline3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgsline3dsymbol.sip.in
@@ -12,7 +12,7 @@
 
 class QgsLine3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness).
 
 .. warning::

diff --git a/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in
@@ -13,7 +13,7 @@
 
 class QgsPoint3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point geometries as 3D objects using one of the predefined shapes.
 
 .. warning::

diff --git a/python/3d/auto_generated/symbols/qgspointcloud3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspointcloud3dsymbol.sip.in
@@ -12,7 +12,7 @@
 
 class QgsPointCloud3DSymbol : QgsAbstract3DSymbol /Abstract/
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point cloud geometries as 3D objects.
 
 .. warning::
@@ -77,7 +77,7 @@ Returns the byte stride for the geometries used to for the vertex buffer
 
 class QgsSingleColorPointCloud3DSymbol : QgsPointCloud3DSymbol
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point cloud geometries as 3D objects.using one color
 
 .. warning::
@@ -128,7 +128,7 @@ Sets the color used by the renderer when using SingleColor rendering mode
 
 class QgsColorRampPointCloud3DSymbol : QgsPointCloud3DSymbol
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point cloud geometries as 3D objects.using color ramp shader
 
 .. warning::
@@ -213,7 +213,7 @@ Sets the minimum and maximum values used when classifying colors in the color ra
 
 class QgsRgbPointCloud3DSymbol : QgsPointCloud3DSymbol
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset
 
 .. warning::
@@ -394,7 +394,7 @@ Ownership of ``enhancement`` is transferred.
 
 class QgsClassificationPointCloud3DSymbol : QgsPointCloud3DSymbol
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws point cloud geometries as 3D objects using classification of the dataset
 
 .. warning::

diff --git a/python/3d/auto_generated/symbols/qgspolygon3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspolygon3dsymbol.sip.in
@@ -13,7 +13,7 @@
 
 class QgsPolygon3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
 {
-%Docstring
+%Docstring(signature="appended")
 3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls).
 
 .. warning::

diff --git a/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in b/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in
@@ -12,7 +12,7 @@
 
 class QgsGcpGeometryTransformer : QgsAbstractGeometryTransformer
 {
-%Docstring
+%Docstring(signature="appended")
 A geometry transformer which uses an underlying Ground Control Points (GCP) based transformation to modify geometries.
 
 .. versionadded:: 3.18

diff --git a/python/analysis/auto_generated/georeferencing/qgsgcptransformer.sip.in b/python/analysis/auto_generated/georeferencing/qgsgcptransformer.sip.in
@@ -10,7 +10,7 @@
 
 class QgsGcpTransformerInterface /Abstract/
 {
-%Docstring
+%Docstring(signature="appended")
 An interface for Ground Control Points (GCP) based transformations.
 
 :py:class:`QgsGcpTransformerInterface` implementations are able to transform point locations

diff --git a/python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in b/python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in
@@ -13,7 +13,7 @@
 
 class QgsGridFileWriter
 {
-%Docstring
+%Docstring(signature="appended")
 A class that does interpolation to a grid and writes the results to an ascii grid.
 %End
 

diff --git a/python/analysis/auto_generated/interpolation/qgsidwinterpolator.sip.in b/python/analysis/auto_generated/interpolation/qgsidwinterpolator.sip.in
@@ -11,7 +11,7 @@
 
 class QgsIDWInterpolator: QgsInterpolator
 {
-%Docstring
+%Docstring(signature="appended")
 Inverse distance weight interpolator.
 %End
 

diff --git a/python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in b/python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in
@@ -32,7 +32,7 @@ Constructor for :py:class:`QgsInterpolatorVertexData`
 
 class QgsInterpolator
 {
-%Docstring
+%Docstring(signature="appended")
 Interface class for interpolations.
 
 Interpolators take

diff --git a/python/analysis/auto_generated/interpolation/qgstininterpolator.sip.in b/python/analysis/auto_generated/interpolation/qgstininterpolator.sip.in
@@ -12,7 +12,7 @@
 
 class QgsTinInterpolator: QgsInterpolator
 {
-%Docstring
+%Docstring(signature="appended")
 Interpolation in a triangular irregular network
 
 .. versionadded:: 3.0

diff --git a/python/analysis/auto_generated/mesh/qgsmeshcontours.sip.in b/python/analysis/auto_generated/mesh/qgsmeshcontours.sip.in
@@ -13,7 +13,7 @@
 
 class QgsMeshContours
 {
-%Docstring
+%Docstring(signature="appended")
 
 Exporter of contours lines or polygons from a mesh layer.
 

diff --git a/python/analysis/auto_generated/mesh/qgsmeshtriangulation.sip.in b/python/analysis/auto_generated/mesh/qgsmeshtriangulation.sip.in
@@ -13,7 +13,7 @@
 
 class QgsMeshTriangulation : QObject
 {
-%Docstring
+%Docstring(signature="appended")
 
 Class that handles mesh creation with Delaunay constrained triangulation
 
@@ -75,7 +75,7 @@ Sets the coordinate reference system used for the triangulation
 
 class QgsMeshZValueDatasetGroup: QgsMeshDatasetGroup
 {
-%Docstring
+%Docstring(signature="appended")
 
 Convenient class that can be used to obtain a datasetgroup on vertices that represents the Z value of the mesh vertices