diff --git a/python/3d/auto_generated/qgscamerapose.sip.in b/python/3d/auto_generated/qgscamerapose.sip.in index 7ccc10084d5..28f44649ca2 100644 --- 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 index 0793316f795..286725b0811 100644 --- 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 new file mode 100644 index 00000000000..4b2ae884032 --- /dev/null +++ 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 index 3512681819c..dc00b6fc9f0 100644 --- 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 - - polygons and have the same number of points and all - points are equal within the specified tolerance - - multipolygons and have the same number of polygons, the polygons have the same number - of rings, and each ring has the same number of points and all points are equal - within the specified - tolerance + +- polylines and have the same number of points and all +points are equal within the specified tolerance +- polygons and have the same number of points and all +points are equal within the specified tolerance +- multipolygons and have the same number of polygons, the polygons have the same number +of rings, and each ring has the same number of points and all points are equal +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 index 44f58650406..876fbd8e20c 100644 --- 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 index a0b43b10074..9aaea46da49 100644 --- 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 index e9ef9dc0169..5e50f268cbf 100644 --- 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 index f800f07e097..9a30eef7235 100644 --- 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 index c999763281c..a8893fb5c76 100644 --- 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 index 848fa47ba8d..37a26d470ca 100644 --- 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:" - handled with createFromOgcWms() - "POSTGIS:" - handled with createFromSrid() - "INTERNAL:" - handled with createFromSrsId() diff --git a/python/core/auto_generated/qgsdataitem.sip.in b/python/core/auto_generated/qgsdataitem.sip.in index 13b1f63f60d..e467285253a 100644 --- 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 index 0b6f4674b51..34fd40bb82b 100644 --- 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 - -> 'WGS84 Web Mercator (Auxiliary Sphere)' calculations - --> latitudes outside these bounds cause the calculations to become unstable and can return invalid results + +- spheroid_project.spheroid_project(...) +- Valid bounds checking for degrees (latitude=+- 85.05115) is based values used for +-> '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 index 892ac5f9f67..8a1c0b12a4f 100644 --- 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 index a43b4de3b14..82a03572279 100644 --- 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 index b7c08d40f5e..b8570899701 100644 --- 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 index 923002926ed..a64aeb2adce 100644 --- 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 index 1e9c6f144e5..61047f35fc4 100644 --- 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" - - "url": base URL, for online services - - "referer": referrer string, for HTTP requests - - "host": hostname, for database services - - "bounds": hardcoded layer bounds (as a QgsRectangle) - - "crs": CRS definition - - "authcfg": authentication configuration ID + +- "path": file path +- "layerName" +- "url": base URL, for online services +- "referer": referrer string, for HTTP requests +- "host": hostname, for database services +- "bounds": hardcoded layer bounds (as a QgsRectangle) +- "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 index 0c08f2a6e6f..24773f87465 100644 --- 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 index e91126171ac..ae7fc231f5a 100644 --- 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. diff --git a/python/core/auto_generated/qgsvectorlayer.sip.in b/python/core/auto_generated/qgsvectorlayer.sip.in index b021ae84382..3f7bcb73668 100644 --- a/python/core/auto_generated/qgsvectorlayer.sip.in +++ b/python/core/auto_generated/qgsvectorlayer.sip.in @@ -55,10 +55,8 @@ as follows: - crs=definition Defines the coordinate reference system to use for the layer. definition is any string accepted by :py:func:`QgsCoordinateReferenceSystem.createFromString()` - - index=yes Specifies that the layer will be constructed with a spatial index - - field=name:type(length,precision) Defines an attribute of the layer. Multiple field parameters can be added to the data provider definition. type is one of "integer", "double", "string". @@ -104,6 +102,7 @@ Used to access data provided by a web feature service. The url can be a HTTP url to a WFS server (legacy, e.g. http://foobar/wfs?TYPENAME=xxx&SRSNAME=yyy[&FILTER=zzz]), or, starting with QGIS 2.16, a URI constructed using the QgsDataSourceUri class with the following parameters : + - url=string (mandatory): HTTP url to a WFS server endpoint. e.g http://foobar/wfs - typename=string (mandatory): WFS typename - srsname=string (recommended): SRS like 'EPSG:XXXX' @@ -111,7 +110,7 @@ starting with QGIS 2.16, a URI constructed using the QgsDataSourceUri class with - password=string - authcfg=string - version=auto/1.0.0/1.1.0/2.0.0 --sql=string: full SELECT SQL statement with optional WHERE, ORDER BY and possibly with JOIN if supported on server +- sql=string: full SELECT SQL statement with optional WHERE, ORDER BY and possibly with JOIN if supported on server - filter=string: QGIS expression or OGC/FES filter - restrictToRequestBBOX=1: to download only features in the view extent (or more generally in the bounding box of the feature iterator) @@ -135,6 +134,7 @@ geometry constructor functions. Used to access data provided by a OGC API - Features server. The URI should be constructed using the QgsDataSourceUri class with the following parameters: + - url=string (mandatory): HTTP url to a OGC API - Features landing page. - typename=string (mandatory): Collection id - username=string @@ -151,7 +151,6 @@ Also note: - You can use various functions available in the QGIS Expression list, however the function must exist server side and have the same name and arguments to work. - - Use the special $geometry parameter to provide the layer geometry column as input into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)')) @@ -183,7 +182,7 @@ Defines the algorithm used to split records into columns. Records are defined by new lines, except for csv format files for which quoted fields may span multiple records. The default type is csv. -- "csv" splits the file based on three sets of characters: +- "csv" splits the file based on three sets of characters: delimiter characters, quote characters, and escape characters. Delimiter characters mark the end of a field. Quote characters enclose a field which can contain @@ -195,14 +194,13 @@ also quote characters are treated specially - they can only escape themselves within quotes. Elsewhere they are treated as quote characters. The defaults for delimiter, quote, and escape are ',', '"', '"'. -- "regexp" splits each record using a regular expression (see QRegExp +- "regexp" splits each record using a regular expression (see QRegExp documentation for details). -- "whitespace" splits each record based on whitespace (on or more whitespace +- "whitespace" splits each record based on whitespace (on or more whitespace characters. Leading whitespace in the record is ignored. -- "plain" is provided for backwards compatibility. It is equivalent to +- "plain" is provided for backwards compatibility. It is equivalent to CSV except that the default quote characters are single and double quotes, and there is no escape characters. - - delimiter=characters Defines the delimiter characters used for csv and plain type files, or the @@ -283,16 +281,16 @@ Defines an expression that will identify a subset of records to display Defines the coordinate reference system used for the layer. This can be any string accepted by :py:func:`QgsCoordinateReferenceSystem.createFromString()` --subsetIndex=(yes|no) +- subsetIndex=(yes|no) Determines whether the provider generates an index to improve the efficiency of subsets. The default is yes --spatialIndex=(yes|no) +- spatialIndex=(yes|no) Determines whether the provider generates a spatial index. The default is no. --watchFile=(yes|no) +- watchFile=(yes|no) Defines whether the file will be monitored for changes. The default is to monitor for changes. @@ -1298,13 +1296,14 @@ Adds a ring to polygon/multipolygon features :param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - AddRingNotInExistingFeature - - InvalidInputGeometryType - - AddRingNotClosed - - AddRingNotValid - - AddRingCrossesExistingRings + +- Success +- LayerNotEditable +- AddRingNotInExistingFeature +- InvalidInputGeometryType +- AddRingNotClosed +- AddRingNotValid +- AddRingCrossesExistingRings .. note:: @@ -1326,13 +1325,14 @@ Adds a ring to polygon/multipolygon features :param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - AddRingNotInExistingFeature - - InvalidInputGeometryType - - AddRingNotClosed - - AddRingNotValid - - AddRingCrossesExistingRings + +- Success +- LayerNotEditable +- AddRingNotInExistingFeature +- InvalidInputGeometryType +- AddRingNotClosed +- AddRingNotValid +- AddRingCrossesExistingRings .. note:: @@ -1350,13 +1350,14 @@ Adds a ring to polygon/multipolygon features (takes ownership) :param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - AddRingNotInExistingFeature - - InvalidInputGeometryType - - AddRingNotClosed - - AddRingNotValid - - AddRingCrossesExistingRings + +- Success +- LayerNotEditable +- AddRingNotInExistingFeature +- InvalidInputGeometryType +- AddRingNotClosed +- AddRingNotValid +- AddRingCrossesExistingRings .. note:: @@ -1375,14 +1376,15 @@ Adds a ring to polygon/multipolygon features (takes ownership) Adds a new part polygon to a multipart feature :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - SelectionIsEmpty - - SelectionIsGreaterThanOne - - AddPartSelectedGeometryNotFound - - AddPartNotMultiGeometry - - InvalidBaseGeometry - - InvalidInputGeometryType + +- Success +- LayerNotEditable +- SelectionIsEmpty +- SelectionIsGreaterThanOne +- AddPartSelectedGeometryNotFound +- AddPartNotMultiGeometry +- InvalidBaseGeometry +- InvalidInputGeometryType .. note:: @@ -1400,14 +1402,15 @@ Adds a new part polygon to a multipart feature Adds a new part polygon to a multipart feature :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - SelectionIsEmpty - - SelectionIsGreaterThanOne - - AddPartSelectedGeometryNotFound - - AddPartNotMultiGeometry - - InvalidBaseGeometry - - InvalidInputGeometryType + +- Success +- LayerNotEditable +- SelectionIsEmpty +- SelectionIsGreaterThanOne +- AddPartSelectedGeometryNotFound +- AddPartNotMultiGeometry +- InvalidBaseGeometry +- InvalidInputGeometryType .. note:: @@ -1429,14 +1432,15 @@ Adds a new part polygon to a multipart feature Adds a new part polygon to a multipart feature :return: QgsGeometry.OperationResult - - Success - - LayerNotEditable - - SelectionIsEmpty - - SelectionIsGreaterThanOne - - AddPartSelectedGeometryNotFound - - AddPartNotMultiGeometry - - InvalidBaseGeometry - - InvalidInputGeometryType + +- Success +- LayerNotEditable +- SelectionIsEmpty +- SelectionIsGreaterThanOne +- AddPartSelectedGeometryNotFound +- AddPartNotMultiGeometry +- InvalidBaseGeometry +- InvalidInputGeometryType .. note:: @@ -1491,13 +1495,14 @@ Splits parts cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: QgsGeometry.OperationResult - - Success - - NothingHappened - - LayerNotEditable - - InvalidInputGeometryType - - InvalidBaseGeometry - - GeometryEngineError - - SplitCannotSplitPoint + +- Success +- NothingHappened +- LayerNotEditable +- InvalidInputGeometryType +- InvalidBaseGeometry +- GeometryEngineError +- SplitCannotSplitPoint .. note:: @@ -1518,13 +1523,14 @@ Splits parts cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: QgsGeometry.OperationResult - - Success - - NothingHappened - - LayerNotEditable - - InvalidInputGeometryType - - InvalidBaseGeometry - - GeometryEngineError - - SplitCannotSplitPoint + +- Success +- NothingHappened +- LayerNotEditable +- InvalidInputGeometryType +- InvalidBaseGeometry +- GeometryEngineError +- SplitCannotSplitPoint .. note:: @@ -1542,13 +1548,14 @@ Splits features cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: QgsGeometry.OperationResult - - Success - - NothingHappened - - LayerNotEditable - - InvalidInputGeometryType - - InvalidBaseGeometry - - GeometryEngineError - - SplitCannotSplitPoint + +- Success +- NothingHappened +- LayerNotEditable +- InvalidInputGeometryType +- InvalidBaseGeometry +- GeometryEngineError +- SplitCannotSplitPoint .. note:: @@ -1569,13 +1576,14 @@ Splits features cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: QgsGeometry.OperationResult - - Success - - NothingHappened - - LayerNotEditable - - InvalidInputGeometryType - - InvalidBaseGeometry - - GeometryEngineError - - SplitCannotSplitPoint + +- Success +- NothingHappened +- LayerNotEditable +- InvalidInputGeometryType +- InvalidBaseGeometry +- GeometryEngineError +- SplitCannotSplitPoint .. note:: diff --git a/python/core/auto_generated/qgsvectorlayereditutils.sip.in b/python/core/auto_generated/qgsvectorlayereditutils.sip.in index 3fe7adea0d9..4a4b6f94657 100644 --- a/python/core/auto_generated/qgsvectorlayereditutils.sip.in +++ b/python/core/auto_generated/qgsvectorlayereditutils.sip.in @@ -108,10 +108,11 @@ Adds a ring to polygon/multipolygon features Adds a new part polygon to a multipart feature :return: - QgsGeometry.Success - - QgsGeometry.AddPartSelectedGeometryNotFound - - QgsGeometry.AddPartNotMultiGeometry - - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.InvalidInput + +- QgsGeometry.AddPartSelectedGeometryNotFound +- QgsGeometry.AddPartNotMultiGeometry +- QgsGeometry.InvalidBaseGeometry +- QgsGeometry.InvalidInput .. deprecated:: QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY. @@ -122,10 +123,11 @@ Adds a new part polygon to a multipart feature Adds a new part polygon to a multipart feature :return: - QgsGeometry.Success - - QgsGeometry.AddPartSelectedGeometryNotFound - - QgsGeometry.AddPartNotMultiGeometry - - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.InvalidInput + +- QgsGeometry.AddPartSelectedGeometryNotFound +- QgsGeometry.AddPartNotMultiGeometry +- QgsGeometry.InvalidBaseGeometry +- QgsGeometry.InvalidInput .. note:: @@ -137,10 +139,11 @@ Adds a new part polygon to a multipart feature Adds a new part polygon to a multipart feature :return: - QgsGeometry.Success - - QgsGeometry.AddPartSelectedGeometryNotFound - - QgsGeometry.AddPartNotMultiGeometry - - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.InvalidInput + +- QgsGeometry.AddPartSelectedGeometryNotFound +- QgsGeometry.AddPartNotMultiGeometry +- QgsGeometry.InvalidBaseGeometry +- QgsGeometry.InvalidInput .. note:: @@ -166,12 +169,13 @@ Splits parts cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.Success - - QgsGeometry.InvalidInput - - QgsGeometry.NothingHappened if a selection is present but no feature has been split - - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.GeometryEngineError - - QgsGeometry.SplitCannotSplitPoint + +- QgsGeometry.Success +- QgsGeometry.InvalidInput +- QgsGeometry.NothingHappened if a selection is present but no feature has been split +- QgsGeometry.InvalidBaseGeometry +- QgsGeometry.GeometryEngineError +- QgsGeometry.SplitCannotSplitPoint .. deprecated:: QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY. @@ -185,12 +189,13 @@ Splits parts cut by the given line :param topologicalEditing: ``True`` if topological editing is enabled :return: - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.Success - - QgsGeometry.InvalidInput - - QgsGeometry.NothingHappened if a selection is present but no feature has been split - - QgsGeometry.InvalidBaseGeometry - - QgsGeometry.GeometryEngineError - - QgsGeometry.SplitCannotSplitPoint + +- QgsGeometry.Success +- QgsGeometry.InvalidInput +- QgsGeometry.NothingHappened if a selection is present but no feature has been split +- QgsGeometry.InvalidBaseGeometry +- QgsGeometry.GeometryEngineError +- QgsGeometry.SplitCannotSplitPoint %End QgsGeometry::OperationResult splitFeatures( const QVector &splitLine, bool topologicalEditing = false ) /Deprecated/; diff --git a/python/core/auto_generated/qgsvectorlayerutils.sip.in b/python/core/auto_generated/qgsvectorlayerutils.sip.in index 9ec2d3a935d..8733df33676 100644 --- a/python/core/auto_generated/qgsvectorlayerutils.sip.in +++ b/python/core/auto_generated/qgsvectorlayerutils.sip.in @@ -246,6 +246,7 @@ layer, note that the number of features returned might be greater than one when converting a multi part geometry to single part The following operations will be performed to convert the input features: + - convert single geometries to multi part - drop additional attributes - drop geometry if layer is geometry-less @@ -266,6 +267,7 @@ layer, note that the number of features returned might be greater than the numbe of input features. The following operations will be performed to convert the input features: + - convert single geometries to multi part - drop additional attributes - drop geometry if layer is geometry-less diff --git a/python/core/auto_generated/raster/qgsrasterlayer.sip.in b/python/core/auto_generated/raster/qgsrasterlayer.sip.in index 30a8ce174b8..90f4959a356 100644 --- a/python/core/auto_generated/raster/qgsrasterlayer.sip.in +++ b/python/core/auto_generated/raster/qgsrasterlayer.sip.in @@ -78,13 +78,9 @@ This is the constructor for the RasterLayer class. The main tasks carried out by the constructor are: - Load the rasters default style (.qml) file if it exists - - Populate the RasterStatsVector with initial values for each band. - - Calculate the layer extents - - Determine whether the layer is gray, paletted or multiband. - - Assign sensible defaults for the red, green, blue and gray bands. %End diff --git a/python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in b/python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in index c6e0d876908..acf461a138f 100644 --- a/python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in +++ b/python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in @@ -1104,6 +1104,7 @@ Used internally when reading/writing symbols. Sets the path to the SVG file to render in the fill. This is usually an absolute file path. Other supported options include + - relative paths to folders from the user's SVG search paths - base64 encoded content, prefixed with a 'base64:' string - http(s) paths diff --git a/python/core/auto_generated/symbology/qgsinterpolatedlinerenderer.sip.in b/python/core/auto_generated/symbology/qgsinterpolatedlinerenderer.sip.in index 7be7108d351..832ab4286b8 100644 --- a/python/core/auto_generated/symbology/qgsinterpolatedlinerenderer.sip.in +++ b/python/core/auto_generated/symbology/qgsinterpolatedlinerenderer.sip.in @@ -81,6 +81,7 @@ Reads configuration from the given DOM element void graduatedColors( double value1, double value2, QList &breakValues, QList &breakColors, QList &gradients ) const; %Docstring Returns the break values, graduated colors and the associated gradients between two values + - If the color is fixed or only one color for the interval (value1, value2), returns only one color in ``breakColors`` and void lists for ``breakValues``, ``gradients`` - If the color ramp is classified with 'exact', returns void ``gradients`` diff --git a/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in b/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in index 174d1fafce7..84206647a87 100644 --- a/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in +++ b/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in @@ -16,10 +16,12 @@ We may need stable references to symbol layers, when pointers to symbol layers i (when a symbol or a feature renderer is cloned for example). A symbol layer identifier consists of: + - an identifier to its symbol (given by the QgsFeatureRenderer) - a path of indexes inside its symbol and subsymbols. For a symbol in a QgsSingleSymbolRenderer that has two symbol layers, it will give: + - "" for the symbol key - [0] and [1] for the two symbol layer indexes @@ -27,6 +29,7 @@ For a QgsRuleBasedRenderer each rule key is the symbol key. For a symbol with a symbol layer that has a sub symbol (say a QgsArrowSymbolLayer), path to symbol layers of the sub symbol are given by a list of indexes: + - [0, 0] : first symbol layer of the sub symbol of the first symbol layer - [0, 1] : second symbol layer of the sub symbol of the first symbol layer - [2, 0] : first symbol layer of the sub symbol of the third symbol layer, etc. diff --git a/python/core/auto_generated/vectortile/qgsvectortilelayer.sip.in b/python/core/auto_generated/vectortile/qgsvectortilelayer.sip.in index 5ab22d8d19d..c4c2befe873 100644 --- a/python/core/auto_generated/vectortile/qgsvectortilelayer.sip.in +++ b/python/core/auto_generated/vectortile/qgsvectortilelayer.sip.in @@ -50,15 +50,18 @@ and does the map rendering. To construct a vector tile layer, it is best to use QgsDataSourceUri class and set the following parameters to get a valid encoded URI: + - "type" - what kind of data source will be used - "url" - URL or path of the data source (specific to each data source type, see below) Currently supported data source types: + - "xyz" - the "url" should be a template like http://example.com/{z}/{x}/{y}.pbf where {x},{y},{z} will be replaced by tile coordinates - "mbtiles" - tiles read from a MBTiles file (a SQLite database) Currently supported decoders: + - MVT - following Mapbox Vector Tiles specification .. versionadded:: 3.14 diff --git a/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in b/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in index 344fed78041..e2fab327380 100644 --- a/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in +++ b/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in @@ -36,6 +36,7 @@ is backend dependent. Currently only "mbtiles" source type supports writing of metadata. The key-value pairs will be written to the "metadata" table in the MBTiles file. Some useful metadata keys listed here, but see MBTiles spec for more details: + - "name" - human-readable name of the tileset - "bounds" - extent in WGS 84: "minlon,minlat,maxlon,maxlat" - "center" - default view of the map: "longitude,latitude,zoomlevel" @@ -45,6 +46,7 @@ for more details: - "description" - descriptions of the content - "type" - whether this is an overlay or a basemap - "version" - version of the tileset + Vector tile writer always writes "format" and "json" metadata. If not specified in metadata by the client, tile writer also writes "name", "bounds", "minzoom" and "maxzoom". diff --git a/python/gui/auto_generated/qgsdockwidget.sip.in b/python/gui/auto_generated/qgsdockwidget.sip.in index 529d17fd72b..4a75b9b133d 100644 --- a/python/gui/auto_generated/qgsdockwidget.sip.in +++ b/python/gui/auto_generated/qgsdockwidget.sip.in @@ -78,11 +78,12 @@ Sets the dock widget as visible to a user, ie both shown and raised to the front When setting a dock as user visible, the dock will be opened (if it is not already opened) and raised to the front. When setting as hidden, the following logic is used: - - hiding a dock which is open but not raised (ie hidden by another tab) will have no - effect, and the dock will still be opened and hidden by the other tab - - hiding a dock which is open and raised (ie, user visible) will cause the dock to - be closed - - hiding a dock which is closed has no effect and raises no signals + +- hiding a dock which is open but not raised (ie hidden by another tab) will have no +effect, and the dock will still be opened and hidden by the other tab +- hiding a dock which is open and raised (ie, user visible) will cause the dock to +be closed +- hiding a dock which is closed has no effect and raises no signals .. seealso:: :py:func:`isUserVisible` diff --git a/python/gui/auto_generated/qgshelp.sip.in b/python/gui/auto_generated/qgshelp.sip.in index 16b061b778d..58c2b5fba2d 100644 --- a/python/gui/auto_generated/qgshelp.sip.in +++ b/python/gui/auto_generated/qgshelp.sip.in @@ -20,6 +20,7 @@ Multiple locations are supported, they will be used in order of preference, from top to bottom. URI construction takes in account following information: + - QGIS version - language of the QGIS UI diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in index 916e6530c68..d500d69fc60 100644 --- a/python/gui/auto_generated/qgsmapcanvas.sip.in +++ b/python/gui/auto_generated/qgsmapcanvas.sip.in @@ -1001,6 +1001,7 @@ Emitted when canvas background color changes void renderComplete( QPainter * ); %Docstring TODO: deprecate when decorations are reimplemented as map canvas items + - anything related to rendering progress is not visible outside of map canvas - additional drawing shall be done directly within the renderer job or independently as a map canvas item %End diff --git a/python/gui/auto_generated/qgsmapcanvastracer.sip.in b/python/gui/auto_generated/qgsmapcanvastracer.sip.in index a70045195de..5efcd25c966 100644 --- a/python/gui/auto_generated/qgsmapcanvastracer.sip.in +++ b/python/gui/auto_generated/qgsmapcanvastracer.sip.in @@ -12,6 +12,7 @@ class QgsMapCanvasTracer : QgsTracer { %Docstring Extension of QgsTracer that provides extra functionality: + - automatic updates of own configuration based on canvas settings - reporting of issues to the user via message bar - determines whether tracing is currently enabled by the user diff --git a/python/server/auto_generated/qgsserverquerystringparameter.sip.in b/python/server/auto_generated/qgsserverquerystringparameter.sip.in index 1d0a6676f40..a2b8e06dd37 100644 --- a/python/server/auto_generated/qgsserverquerystringparameter.sip.in +++ b/python/server/auto_generated/qgsserverquerystringparameter.sip.in @@ -67,6 +67,7 @@ value and converting it to its proper Type. If the value is not set and a default was not provided an invalid QVariant is returned. Validation steps: + - required - can convert to proper Type - custom validator (if set - not available in Python bindings) diff --git a/src/app/qgsmaptooladdcircularstring.h b/src/app/qgsmaptooladdcircularstring.h index eaa7d647f51..356dac96cdc 100644 --- a/src/app/qgsmaptooladdcircularstring.h +++ b/src/app/qgsmaptooladdcircularstring.h @@ -47,7 +47,7 @@ class APP_EXPORT QgsMapToolAddCircularString: public QgsMapToolCapture /** * The parent map tool, e.g. the add feature tool. * Completed circular strings will be added to this tool by calling its addCurve() method. - * */ + */ QgsMapToolCapture *mParentTool = nullptr; //! Circular string points (in map coordinates) QgsPointSequence mPoints; diff --git a/src/app/qgsmaptoolfillring.h b/src/app/qgsmaptoolfillring.h index 646e2a95a6b..978c30918e7 100644 --- a/src/app/qgsmaptoolfillring.h +++ b/src/app/qgsmaptoolfillring.h @@ -20,7 +20,7 @@ /** * A tool to cut holes into polygon and multipolygon features and fill them * with new feature. Attributes are copied from parent feature. - * */ + */ class APP_EXPORT QgsMapToolFillRing: public QgsMapToolCapture { Q_OBJECT diff --git a/src/core/pal/palexception.h b/src/core/pal/palexception.h index 21877cdd467..3b823a7248b 100644 --- a/src/core/pal/palexception.h +++ b/src/core/pal/palexception.h @@ -111,7 +111,6 @@ namespace pal * It can be thrown by : * * - pal::Layer::setFeatureLabelSize if either the height or the width of the label is < 0 - * * - pal::Layer::setFeatureDistlabel is distlable < 0 */ class ValueNotInRange : public std::exception diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index 36f7f477f78..6f8e6c52a43 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -82,7 +82,6 @@ struct LayerRenderJob * - One of its symbol layer masks a symbol layer of another layer. * In this case we need to compute a mask image during the regular * rendering pass that will be stored here; - * * - Some of its symbol layers are masked by a symbol layer of another layer (or by a label mask) * In this case we need to render the layer once again in a second pass, but with some symbol * layers disabled. diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index 9097661a74c..c71f6ec26e8 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -121,10 +121,8 @@ typedef QSet QgsAttributeIds; * - crs=definition * Defines the coordinate reference system to use for the layer. * definition is any string accepted by QgsCoordinateReferenceSystem::createFromString() - * * - index=yes * Specifies that the layer will be constructed with a spatial index - * * - field=name:type(length,precision) * Defines an attribute of the layer. Multiple field parameters can be added * to the data provider definition. type is one of "integer", "double", "string". @@ -220,7 +218,6 @@ typedef QSet QgsAttributeIds; * * - You can use various functions available in the QGIS Expression list, * however the function must exist server side and have the same name and arguments to work. - * * - Use the special $geometry parameter to provide the layer geometry column as input * into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)')) * @@ -271,7 +268,6 @@ typedef QSet QgsAttributeIds; * - "plain" is provided for backwards compatibility. It is equivalent to * CSV except that the default quote characters are single and double quotes, * and there is no escape characters. - * * - delimiter=characters * * Defines the delimiter characters used for csv and plain type files, or the @@ -2317,7 +2313,6 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * * - the user is visibly informed that his changes were not saved and what he needs * to do in order to be able to save the changes. - * * - to set the property back to TRUE, once the user has fixed his data. * * When calling \see commitChanges(), this flag is checked just after the @@ -2337,7 +2332,6 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * * - the user is visibly informed that his changes were not saved and what he needs * to do in order to be able to save the changes. - * * - to set the property back to TRUE, once the user has fixed his data. * * When calling \see commitChanges(), this flag is checked just after the diff --git a/src/core/raster/qgsrasterlayer.h b/src/core/raster/qgsrasterlayer.h index 329704ee37a..c60cdf5b1b2 100644 --- a/src/core/raster/qgsrasterlayer.h +++ b/src/core/raster/qgsrasterlayer.h @@ -146,16 +146,12 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer * The main tasks carried out by the constructor are: * * - Load the rasters default style (.qml) file if it exists - * * - Populate the RasterStatsVector with initial values for each band. - * * - Calculate the layer extents - * * - Determine whether the layer is gray, paletted or multiband. - * * - Assign sensible defaults for the red, green, blue and gray bands. * - * */ + */ explicit QgsRasterLayer( const QString &uri, const QString &baseName = QString(), const QString &providerType = "gdal", diff --git a/src/core/symbology/qgsstyle.h b/src/core/symbology/qgsstyle.h index 66c0bfeaaa1..09a30193ec5 100644 --- a/src/core/symbology/qgsstyle.h +++ b/src/core/symbology/qgsstyle.h @@ -743,7 +743,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param qword is the query string to search the symbols or colorramps. * \returns A QStringList of the matched symbols or colorramps - * */ + */ QStringList findSymbols( StyleEntity type, const QString &qword ); /** diff --git a/src/gui/qgsmaptoolextent.h b/src/gui/qgsmaptoolextent.h index c1fe8223c2e..2ee746ac6da 100644 --- a/src/gui/qgsmaptoolextent.h +++ b/src/gui/qgsmaptoolextent.h @@ -50,13 +50,13 @@ class GUI_EXPORT QgsMapToolExtent : public QgsMapTool * Sets a fixed aspect ratio to be used when dragging extent onto the canvas. * To unset a fixed aspect ratio, set the width and height to zero. * \param ratio aspect ratio's width and height - * */ + */ void setRatio( QSize ratio ) { mRatio = ratio; } /** * Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. * If the aspect ratio isn't fixed, the width and height will be set to zero. - * */ + */ QSize ratio() const { return mRatio; } /** diff --git a/src/server/services/wms/qgswmsrenderer.h b/src/server/services/wms/qgswmsrenderer.h index 7d85abf1a76..9adee5cadf7 100644 --- a/src/server/services/wms/qgswmsrenderer.h +++ b/src/server/services/wms/qgswmsrenderer.h @@ -271,13 +271,13 @@ namespace QgsWms //! Gets layer search rectangle (depending on request parameter, layer type, map and layer crs) QgsRectangle featureInfoSearchRect( QgsVectorLayer *ml, const QgsMapSettings &ms, const QgsRenderContext &rct, const QgsPointXY &infoPoint ) const; - /* + /** * Configures the print layout for the GetPrint request *\param c the print layout *\param mapSettings the map settings *\param atlasPrint true if atlas is used for printing *\returns true in case of success - * */ + */ bool configurePrintLayout( QgsPrintLayout *c, const QgsMapSettings &mapSettings, bool atlasPrint = false ); void removeTemporaryLayers();