Updates

qgis · Jun 11, 2020 · c795ddb · c795ddb
1 parent e293a9d
commit c795ddb
Show file tree

Hide file tree

Showing 42 changed files with 198 additions and 158 deletions.
diff --git a/python/3d/auto_generated/qgscamerapose.sip.in b/python/3d/auto_generated/qgscamerapose.sip.in
@@ -15,6 +15,7 @@ class QgsCameraPose
 {
 %Docstring
 Class that encapsulates camera pose in a 3D scene. The pose is defined with the following parameters:
+
 - center point - towards which point the camera is looking
 - distance from the center point - how far is the camera from the point towards which it is looking
 - pitch angle - vertical rotation of the camera (0 degrees = camera looking down, 90 degrees = camera looking from the side)

diff --git a/python/analysis/auto_generated/raster/qgsalignraster.sip.in b/python/analysis/auto_generated/raster/qgsalignraster.sip.in
@@ -16,6 +16,7 @@ class QgsAlignRaster
 %Docstring
 QgsAlignRaster takes one or more raster layers and warps (resamples) them
 so they have the same:
+
 - coordinate reference system
 - cell size and raster size
 - offset of the raster grid

diff --git a/python/core/auto_additions/qgsmapsettingsutils.py b/python/core/auto_additions/qgsmapsettingsutils.py
@@ -0,0 +1,5 @@
+# The following has been generated automatically from src/core/qgsmapsettingsutils.h
+# monkey patching scoped based enum
+QgsMapSettingsUtils.EffectsCheckFlag.IgnoreGeoPdfSupportedEffects.__doc__ = "Ignore advanced effects which are supported in GeoPDF exports"
+QgsMapSettingsUtils.EffectsCheckFlag.__doc__ = 'Flags for controlling the behavior of containsAdvancedEffects()\n\n.. versionadded:: 3.14\n\n' + '* ``IgnoreGeoPdfSupportedEffects``: ' + QgsMapSettingsUtils.EffectsCheckFlag.IgnoreGeoPdfSupportedEffects.__doc__
+# --
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1568,6 +1568,7 @@ Exports the geometry to a GeoJSON string.
 Attempts to coerce this geometry into the specified destination ``type``.
 
 This method will do anything possible to force the current geometry into the specified type. E.g.
+
 - lines or polygons will be converted to points by return either a single multipoint geometry or multiple
 single point geometries.
 - polygons will be converted to lines by extracting their exterior and interior rings, returning
@@ -2122,14 +2123,14 @@ The 2 types should match.
 :param epsilon: maximum difference for coordinates between the objects
 
 :return: ``True`` if objects are
-         - polylines and have the same number of points and all
+
-         points are equal within the specified tolerance
+- polylines and have the same number of points and all
-         - polygons and have the same number of points and all
+points are equal within the specified tolerance
-         points are equal within the specified tolerance
+- polygons and have the same number of points and all
-         - multipolygons and  have the same number of polygons, the polygons have the same number
+points are equal within the specified tolerance
-         of rings, and each ring has the same number of points and all points are equal
+- multipolygons and  have the same number of polygons, the polygons have the same number
-         within the specified
+of rings, and each ring has the same number of points and all points are equal
-         tolerance
+within the specified tolerance
 
 .. versionadded:: 2.9
 %End

diff --git a/python/core/auto_generated/geometry/qgsquadrilateral.sip.in b/python/core/auto_generated/geometry/qgsquadrilateral.sip.in
@@ -149,6 +149,7 @@ Returns ``False`` if the QgsQuadrilateral is not valid.
 %Docstring
 Set all points
 Returns ``False`` if the QgsQuadrilateral is not valid:
+
 - The points do not have the same type
 - The quadrilateral would have auto intersections
 - The quadrilateral has double points

diff --git a/python/core/auto_generated/layertree/qgslayertreenode.sip.in b/python/core/auto_generated/layertree/qgslayertreenode.sip.in
@@ -16,6 +16,7 @@ class QgsLayerTreeNode : QObject
 %Docstring
 This class is a base class for nodes in a layer tree.
 Layer tree is a hierarchical structure consisting of group and layer nodes:
+
 - group nodes are containers and may contain children (layer and group nodes)
 - layer nodes point to map layers, they do not contain further children
 
@@ -42,6 +43,7 @@ used by third party plugins. Custom properties are stored also in the project
 file. The storage is not efficient for large amount of data.
 
 Custom properties that have already been used within QGIS:
+
 - "loading" - whether the project is being currently loaded (root node only)
 - "overview" - whether to show a layer in overview
 - "showFeatureCount" - whether to show feature counts in layer tree (vector only)

diff --git a/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in b/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in
@@ -84,6 +84,7 @@ class QgsMeshDataSourceInterface /Abstract/
 Interface for mesh data sources
 
 Mesh is a collection of vertices, edges and faces in 2D or 3D space
+
 - vertex - XY(Z) point (in the mesh's coordinate reference system)
 - edge   - two XY(Z) points (in the mesh's coordinate reference system) representing straight seqment
 - faces  - sets of vertices forming a closed shape - typically triangles or quadrilaterals

diff --git a/python/core/auto_generated/mesh/qgsmeshlayer.sip.in b/python/core/auto_generated/mesh/qgsmeshlayer.sip.in
@@ -392,6 +392,7 @@ Returns the root items of the dataset group tree item
 %Docstring
 Sets the root items of the dataset group tree item.
 Changes active dataset groups if those one are not enabled anymore :
+
 - new active scalar dataset group is the first root item enabled child
 - new active vector dataset group is none
 

diff --git a/python/core/auto_generated/mesh/qgsmeshlayertemporalproperties.sip.in b/python/core/auto_generated/mesh/qgsmeshlayertemporalproperties.sip.in
@@ -17,6 +17,7 @@ class QgsMeshLayerTemporalProperties : QgsMapLayerTemporalProperties
 Implementation of map layer temporal properties for mesh layers.
 
 The time in a mesh layer is defined by :
+
 - a reference time provided by the data, the project or the user
 - each dataset is associated with a relative times
 - time extent is defined by the first time and the last time of all dataset

diff --git a/python/core/auto_generated/qgscoordinatereferencesystem.sip.in b/python/core/auto_generated/qgscoordinatereferencesystem.sip.in
@@ -498,6 +498,7 @@ We try to match the Proj string to internal QGIS CRS ID using the following logi
 Set up this CRS from a string definition.
 
 It supports the following formats:
+
 - "EPSG:<code>" - handled with createFromOgcWms()
 - "POSTGIS:<srid>" - handled with createFromSrid()
 - "INTERNAL:<srsid>" - handled with createFromSrsId()

diff --git a/python/core/auto_generated/qgsdataitem.sip.in b/python/core/auto_generated/qgsdataitem.sip.in
@@ -404,6 +404,7 @@ createChildren() immediately because result will be useless. *
     virtual void deleteLater();
 %Docstring
 Safely delete the item:
+
 - disconnects parent
 - unsets parent (but does not remove itself)
 - deletes all its descendants recursively

diff --git a/python/core/auto_generated/qgsdistancearea.sip.in b/python/core/auto_generated/qgsdistancearea.sip.in
@@ -362,10 +362,11 @@ Datum of Australia Technical Manual", Chapter 4.
 
    code (and documentation) taken from rttopo project
    https://git.osgeo.org/gogs/rttopo/librttopo
-   - spheroid_project.spheroid_project(...)
+
-   -  Valid bounds checking for degrees (latitude=+- 85.05115) is based values used for
+- spheroid_project.spheroid_project(...)
-   -> 'WGS84 Web Mercator (Auxiliary Sphere)' calculations
+- Valid bounds checking for degrees (latitude=+- 85.05115) is based values used for
-   --> latitudes outside these bounds cause the calculations to become unstable and can return invalid results
+-> 'WGS84 Web Mercator (Auxiliary Sphere)' calculations
+--> latitudes outside these bounds cause the calculations to become unstable and can return invalid results
 
 .. versionadded:: 3.0
 %End

diff --git a/python/core/auto_generated/qgsfields.sip.in b/python/core/auto_generated/qgsfields.sip.in
@@ -16,6 +16,7 @@ class QgsFields
 Container of fields for a vector layer.
 
 In addition to storing a list of QgsField instances, it also:
+
 - allows quick lookups of field names to index in the list
 - keeps track of where the field definition comes from (vector data provider, joined layer or newly added from an editing operation)
 

diff --git a/python/core/auto_generated/qgsmaplayerdependency.sip.in b/python/core/auto_generated/qgsmaplayerdependency.sip.in
@@ -16,6 +16,7 @@ class QgsMapLayerDependency
 This class models dependencies with or between map layers.
 A dependency is defined by a layer ID, a type and an origin.
 The two combinations of type/origin that are currently supported are:
+
 - PresenceDependency && FromProvider: virtual layers for instance which may depend on other layers already loaded to work
 - DataDependency && FromUser: dependencies given by the user, mainly to represent database triggers
 

diff --git a/python/core/auto_generated/qgsogcutils.sip.in b/python/core/auto_generated/qgsogcutils.sip.in
@@ -17,6 +17,7 @@ The QgsOgcUtils class provides various utility functions for conversion between
 OGC (Open Geospatial Consortium) standards and QGIS internal representations.
 
 Currently supported standards:
+
 - GML2 - Geography Markup Language (import, export)
 %End
 

diff --git a/python/core/auto_generated/qgspointlocator.sip.in b/python/core/auto_generated/qgspointlocator.sip.in
@@ -20,6 +20,7 @@ class QgsPointLocator : QObject
 {
 %Docstring
 The class defines interface for querying point location:
+
 - query nearest vertices / edges to a point
 - query vertices / edges in rectangle
 - query areas covering a point

diff --git a/python/core/auto_generated/qgsprovidermetadata.sip.in b/python/core/auto_generated/qgsprovidermetadata.sip.in
@@ -229,14 +229,15 @@ Breaks a provider data source URI into its component paths (e.g. file path, laye
 :param uri: uri string
 
 :return: map containing components. Standard components may include:
-         - "path": file path
+
-         - "layerName"
+- "path": file path
-         - "url": base URL, for online services
+- "layerName"
-         - "referer": referrer string, for HTTP requests
+- "url": base URL, for online services
-         - "host": hostname, for database services
+- "referer": referrer string, for HTTP requests
-         - "bounds": hardcoded layer bounds (as a QgsRectangle)
+- "host": hostname, for database services
-         - "crs": CRS definition
+- "bounds": hardcoded layer bounds (as a QgsRectangle)
-         - "authcfg": authentication configuration ID
+- "crs": CRS definition
+- "authcfg": authentication configuration ID
 
 .. note::
 

diff --git a/python/core/auto_generated/qgssnappingutils.sip.in b/python/core/auto_generated/qgssnappingutils.sip.in
@@ -17,8 +17,10 @@ This class has all the configuration of snapping and can return answers to snapp
 Internally, it keeps a cache of QgsPointLocator instances for multiple layers.
 
 Currently it supports the following queries:
+
 - snapToMap() - has multiple modes of operation
 - snapToCurrentLayer()
+
 For more complex queries it is possible to use locatorForLayer() method that returns
 point locator instance with layer's indexed data.
 

diff --git a/python/core/auto_generated/qgsspatialindexkdbush.sip.in b/python/core/auto_generated/qgsspatialindexkdbush.sip.in
@@ -17,11 +17,13 @@ class QgsSpatialIndexKDBush
 A very fast static spatial index for 2D points based on a flat KD-tree.
 
 Compared to QgsSpatialIndex, this index:
+
 - supports single point features only (no multipoints)
 - is static (features cannot be added or removed from the index after construction)
 - is much faster!
 - allows direct retrieval of the original feature's points, without requiring additional feature requests
 - supports true "distance based" searches, i.e. return all points within a radius
+
 from a search point
 
 QgsSpatialIndexKDBush objects are implicitly shared and can be inexpensively copied.