From 04b342c33d4643667150d7e96e513d68653ef7f7 Mon Sep 17 00:00:00 2001 From: DelazJ Date: Thu, 15 May 2025 13:35:08 +0200 Subject: [PATCH] [Processing algorithms] Add more short description methods --- ...orithmexecutespatialitequeryregistered.cpp | 5 +++ ...lgorithmexecutespatialitequeryregistered.h | 1 + .../processing/qgsalgorithmexplodehstore.cpp | 5 +++ .../processing/qgsalgorithmexplodehstore.h | 1 + .../qgsalgorithmexportgeometryattributes.cpp | 7 +++- .../qgsalgorithmexportgeometryattributes.h | 1 + .../qgsalgorithmexportlayersinformation.cpp | 7 +++- .../qgsalgorithmexportlayersinformation.h | 1 + .../qgsalgorithmexporttospreadsheet.cpp | 5 +++ .../qgsalgorithmexporttospreadsheet.h | 1 + .../qgsalgorithmextentfromlayer.cpp | 5 +++ .../processing/qgsalgorithmextentfromlayer.h | 1 + .../processing/qgsalgorithmextenttolayer.cpp | 5 +++ .../processing/qgsalgorithmextenttolayer.h | 1 + .../processing/qgsalgorithmextractbinary.cpp | 2 +- .../qgsalgorithmextractbyattribute.cpp | 5 +++ .../qgsalgorithmextractbyattribute.h | 1 + .../qgsalgorithmextractbyexpression.cpp | 5 +++ .../qgsalgorithmextractbyexpression.h | 1 + .../qgsalgorithmextractbyextent.cpp | 5 +++ .../processing/qgsalgorithmextractbyextent.h | 1 + .../qgsalgorithmextractbylocation.cpp | 10 +++++ .../qgsalgorithmextractbylocation.h | 2 + .../qgsalgorithmextractspecificvertices.cpp | 5 +++ .../qgsalgorithmextractspecificvertices.h | 1 + .../qgsalgorithmextractvertices.cpp | 5 +++ .../processing/qgsalgorithmextractvertices.h | 1 + .../qgsalgorithmfieldcalculator.cpp | 6 +++ .../processing/qgsalgorithmfieldcalculator.h | 1 + .../processing/qgsalgorithmfillnodata.cpp | 5 +++ .../processing/qgsalgorithmfillnodata.h | 1 + .../qgsalgorithmfillsinkswangliu.cpp | 5 +++ .../processing/qgsalgorithmfillsinkswangliu.h | 1 + .../processing/qgsalgorithmfilter.cpp | 5 +++ src/analysis/processing/qgsalgorithmfilter.h | 1 + .../processing/qgsalgorithmfiltervertices.cpp | 6 +++ .../processing/qgsalgorithmfiltervertices.h | 1 + .../processing/qgsalgorithmfixgeometries.cpp | 5 +++ .../processing/qgsalgorithmfixgeometries.h | 1 + .../processing/qgsalgorithmfuzzifyraster.cpp | 38 +++++++++++++++++-- .../processing/qgsalgorithmfuzzifyraster.h | 6 +++ .../qgsalgorithmgenerateelevationprofile.cpp | 5 +++ .../qgsalgorithmgenerateelevationprofile.h | 1 + .../qgsalgorithmgeometrybyexpression.cpp | 6 +++ .../qgsalgorithmgeometrybyexpression.h | 1 + .../processing/qgsalgorithmgltftovector.cpp | 5 +++ .../processing/qgsalgorithmgltftovector.h | 1 + .../processing/qgsalgorithmgpsbabeltools.cpp | 20 ++++++++++ .../processing/qgsalgorithmgpsbabeltools.h | 4 ++ src/analysis/processing/qgsalgorithmgrid.cpp | 4 ++ src/analysis/processing/qgsalgorithmgrid.h | 1 + .../processing/qgsalgorithmhillshade.cpp | 5 +++ .../processing/qgsalgorithmhillshade.h | 1 + .../processing/qgsalgorithmimportphotos.cpp | 7 +++- .../processing/qgsalgorithmimportphotos.h | 1 + .../processing/qgsalgorithmintersection.cpp | 5 +++ .../processing/qgsalgorithmintersection.h | 1 + .../qgsalgorithmjoinbyattribute.cpp | 6 +++ .../processing/qgsalgorithmjoinbyattribute.h | 1 + .../qgsalgorithmkeepnbiggestparts.cpp | 6 +++ .../qgsalgorithmkeepnbiggestparts.h | 1 + .../qgsalgorithmkmeansclustering.cpp | 7 +++- .../processing/qgsalgorithmkmeansclustering.h | 1 + .../processing/qgsalgorithmlinedensity.cpp | 8 +++- .../processing/qgsalgorithmlinedensity.h | 1 + .../qgsalgorithmlineintersection.cpp | 5 +++ .../processing/qgsalgorithmlineintersection.h | 1 + .../processing/qgsalgorithmloadlayer.cpp | 5 +++ .../processing/qgsalgorithmloadlayer.h | 1 + .../qgsalgorithmmeancoordinates.cpp | 5 +++ .../processing/qgsalgorithmmeancoordinates.h | 1 + .../processing/qgsalgorithmmergelines.cpp | 5 +++ .../processing/qgsalgorithmmergelines.h | 1 + .../qgsalgorithmmeshsurfacetopolygon.cpp | 7 +++- .../qgsalgorithmmeshsurfacetopolygon.h | 1 + .../qgsalgorithmminimumenclosingcircle.cpp | 5 +++ .../qgsalgorithmminimumenclosingcircle.h | 1 + .../qgsalgorithmmultidifference.cpp | 5 +++ .../processing/qgsalgorithmmultidifference.h | 1 + .../qgsalgorithmmultiintersection.cpp | 5 +++ .../qgsalgorithmmultiintersection.h | 1 + .../qgsalgorithmmultiparttosinglepart.cpp | 5 +++ .../qgsalgorithmmultiparttosinglepart.h | 1 + .../qgsalgorithmmultiringconstantbuffer.cpp | 7 +++- .../qgsalgorithmmultiringconstantbuffer.h | 1 + .../processing/qgsalgorithmmultiunion.cpp | 5 +++ .../processing/qgsalgorithmmultiunion.h | 1 + .../qgsalgorithmnearestneighbouranalysis.cpp | 5 +++ .../qgsalgorithmnearestneighbouranalysis.h | 1 + .../qgsalgorithmorderbyexpression.cpp | 5 +++ .../qgsalgorithmorderbyexpression.h | 1 + ...qgsalgorithmorientedminimumboundingbox.cpp | 5 +++ .../qgsalgorithmorientedminimumboundingbox.h | 1 + .../processing/qgsalgorithmorthogonalize.cpp | 6 +++ .../processing/qgsalgorithmorthogonalize.h | 1 + .../processing/qgsalgorithmpackage.cpp | 5 +++ src/analysis/processing/qgsalgorithmpackage.h | 1 + ...qgsalgorithmpixelcentroidsfrompolygons.cpp | 7 +++- .../qgsalgorithmpixelcentroidsfrompolygons.h | 1 + .../processing/qgsalgorithmpointonsurface.cpp | 5 +++ .../processing/qgsalgorithmpointonsurface.h | 1 + .../qgsalgorithmpointslayerfromtable.cpp | 5 +++ .../qgsalgorithmpointslayerfromtable.h | 1 + .../processing/qgsalgorithmpointstopaths.cpp | 5 +++ .../processing/qgsalgorithmpointstopaths.h | 1 + .../processing/qgsalgorithmpointtolayer.cpp | 5 +++ .../processing/qgsalgorithmpointtolayer.h | 1 + .../qgsalgorithmpoleofinaccessibility.cpp | 6 +++ .../qgsalgorithmpoleofinaccessibility.h | 1 + .../processing/qgsalgorithmpolygonize.cpp | 5 +++ .../processing/qgsalgorithmpolygonize.h | 1 + .../qgsalgorithmpolygonstolines.cpp | 2 +- .../qgsalgorithmprojectpointcartesian.cpp | 5 +++ .../qgsalgorithmprojectpointcartesian.h | 1 + .../qgsalgorithmpromotetomultipart.cpp | 5 +++ .../qgsalgorithmpromotetomultipart.h | 1 + 116 files changed, 417 insertions(+), 14 deletions(-) diff --git a/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.cpp b/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.cpp index b4b3f0fe520..c9b02ccd9a9 100644 --- a/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.cpp +++ b/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.cpp @@ -48,6 +48,11 @@ QString QgsExecuteRegisteredSpatialiteQueryAlgorithm::groupId() const } QString QgsExecuteRegisteredSpatialiteQueryAlgorithm::shortHelpString() const +{ + return QObject::tr( "This algorithm executes a SQL command on a SpatiaLite database." ); +} + +QString QgsExecuteRegisteredSpatialiteQueryAlgorithm::shortDescription() const { return QObject::tr( "Executes a SQL command on a SpatiaLite database." ); } diff --git a/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.h b/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.h index d0aa46efb1b..ba233197fce 100644 --- a/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.h +++ b/src/analysis/processing/qgsalgorithmexecutespatialitequeryregistered.h @@ -39,6 +39,7 @@ class QgsExecuteRegisteredSpatialiteQueryAlgorithm : public QgsProcessingAlgorit QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExecuteRegisteredSpatialiteQueryAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmexplodehstore.cpp b/src/analysis/processing/qgsalgorithmexplodehstore.cpp index df027453bf3..f051b0b6c5b 100644 --- a/src/analysis/processing/qgsalgorithmexplodehstore.cpp +++ b/src/analysis/processing/qgsalgorithmexplodehstore.cpp @@ -53,6 +53,11 @@ QString QgsExplodeHstoreAlgorithm::shortHelpString() const "The expected field list is an optional comma separated list. By default, all unique keys are added. If this list is specified, only these fields are added and the HStore field is updated." ); } +QString QgsExplodeHstoreAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a copy of the input layer and adds a new field for every unique key in the HStore field." ); +} + QgsProcessingAlgorithm *QgsExplodeHstoreAlgorithm::createInstance() const { return new QgsExplodeHstoreAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmexplodehstore.h b/src/analysis/processing/qgsalgorithmexplodehstore.h index 0e90b890465..693efd2223e 100644 --- a/src/analysis/processing/qgsalgorithmexplodehstore.h +++ b/src/analysis/processing/qgsalgorithmexplodehstore.h @@ -38,6 +38,7 @@ class QgsExplodeHstoreAlgorithm : public QgsProcessingAlgorithm QString groupId() const override; QStringList tags() const override; QString shortHelpString() const override; + QString shortDescription() const override; protected: QgsProcessingAlgorithm *createInstance() const override; diff --git a/src/analysis/processing/qgsalgorithmexportgeometryattributes.cpp b/src/analysis/processing/qgsalgorithmexportgeometryattributes.cpp index 864f14c1b5c..668dbee5e9e 100644 --- a/src/analysis/processing/qgsalgorithmexportgeometryattributes.cpp +++ b/src/analysis/processing/qgsalgorithmexportgeometryattributes.cpp @@ -49,13 +49,18 @@ QString QgsExportGeometryAttributesAlgorithm::groupId() const QString QgsExportGeometryAttributesAlgorithm::shortHelpString() const { - return QObject::tr( "Computes geometric properties of the features in a vector layer. Algorithm generates a new " + return QObject::tr( "This algorithm computes geometric properties of the features in a vector layer. Algorithm generates a new " "vector layer with the same content as the input one, but with additional attributes in its " "attributes table, containing geometric measurements.\n\n" "Depending on the geometry type of the vector layer, the attributes added to the table will " "be different." ); } +QString QgsExportGeometryAttributesAlgorithm::shortDescription() const +{ + return QObject::tr( "Computes geometric properties of the features in a vector layer." ); +} + QgsExportGeometryAttributesAlgorithm *QgsExportGeometryAttributesAlgorithm::createInstance() const { return new QgsExportGeometryAttributesAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmexportgeometryattributes.h b/src/analysis/processing/qgsalgorithmexportgeometryattributes.h index 74b50b87849..d40612aea6f 100644 --- a/src/analysis/processing/qgsalgorithmexportgeometryattributes.h +++ b/src/analysis/processing/qgsalgorithmexportgeometryattributes.h @@ -43,6 +43,7 @@ class QgsExportGeometryAttributesAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExportGeometryAttributesAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmexportlayersinformation.cpp b/src/analysis/processing/qgsalgorithmexportlayersinformation.cpp index ece58685992..e4f20741539 100644 --- a/src/analysis/processing/qgsalgorithmexportlayersinformation.cpp +++ b/src/analysis/processing/qgsalgorithmexportlayersinformation.cpp @@ -53,10 +53,15 @@ void QgsExportLayersInformationAlgorithm::initAlgorithm( const QVariantMap & ) QString QgsExportLayersInformationAlgorithm::shortHelpString() const { - return QObject::tr( "Creates a polygon layer with features corresponding to the extent of selected layer(s).\n\n" + return QObject::tr( "This algorithm creates a polygon layer with features corresponding to the extent of selected layer(s).\n\n" "Additional layer details - CRS, provider name, file path, layer name, subset filter, abstract and attribution - are attached as attributes to each feature." ); } +QString QgsExportLayersInformationAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a polygon layer with features corresponding to the extent of selected layer(s)." ); +} + QgsExportLayersInformationAlgorithm *QgsExportLayersInformationAlgorithm::createInstance() const { return new QgsExportLayersInformationAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmexportlayersinformation.h b/src/analysis/processing/qgsalgorithmexportlayersinformation.h index fc003b420bd..0b6b09b35bd 100644 --- a/src/analysis/processing/qgsalgorithmexportlayersinformation.h +++ b/src/analysis/processing/qgsalgorithmexportlayersinformation.h @@ -39,6 +39,7 @@ class QgsExportLayersInformationAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExportLayersInformationAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmexporttospreadsheet.cpp b/src/analysis/processing/qgsalgorithmexporttospreadsheet.cpp index f12fba9b621..b67b3ea9158 100644 --- a/src/analysis/processing/qgsalgorithmexporttospreadsheet.cpp +++ b/src/analysis/processing/qgsalgorithmexporttospreadsheet.cpp @@ -135,6 +135,11 @@ QString QgsExportToSpreadsheetAlgorithm::shortHelpString() const "Optionally the layers can be appended to an existing spreadsheet as additional sheets.\n\n" ); } +QString QgsExportToSpreadsheetAlgorithm::shortDescription() const +{ + return QObject::tr( "Collects a number of existing layers and exports them into a spreadsheet document." ); +} + QgsExportToSpreadsheetAlgorithm *QgsExportToSpreadsheetAlgorithm::createInstance() const { return new QgsExportToSpreadsheetAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmexporttospreadsheet.h b/src/analysis/processing/qgsalgorithmexporttospreadsheet.h index 40d0e82391e..0ed1d1b8391 100644 --- a/src/analysis/processing/qgsalgorithmexporttospreadsheet.h +++ b/src/analysis/processing/qgsalgorithmexporttospreadsheet.h @@ -42,6 +42,7 @@ class QgsExportToSpreadsheetAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExportToSpreadsheetAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextentfromlayer.cpp b/src/analysis/processing/qgsalgorithmextentfromlayer.cpp index f425787193d..ab5cf51d270 100644 --- a/src/analysis/processing/qgsalgorithmextentfromlayer.cpp +++ b/src/analysis/processing/qgsalgorithmextentfromlayer.cpp @@ -54,6 +54,11 @@ QString QgsExtentFromLayerAlgorithm::shortHelpString() const "extent can be enlarged to a rounded value." ); } +QString QgsExtentFromLayerAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a vector layer with the minimum bounding box that covers the input layer." ); +} + QString QgsExtentFromLayerAlgorithm::svgIconPath() const { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmExtractLayerExtent.svg" ) ); diff --git a/src/analysis/processing/qgsalgorithmextentfromlayer.h b/src/analysis/processing/qgsalgorithmextentfromlayer.h index 1abe3889802..73276365254 100644 --- a/src/analysis/processing/qgsalgorithmextentfromlayer.h +++ b/src/analysis/processing/qgsalgorithmextentfromlayer.h @@ -39,6 +39,7 @@ class QgsExtentFromLayerAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QString svgIconPath() const override; QIcon icon() const override; QgsExtentFromLayerAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmextenttolayer.cpp b/src/analysis/processing/qgsalgorithmextenttolayer.cpp index 1875a633656..dd43a18c135 100644 --- a/src/analysis/processing/qgsalgorithmextenttolayer.cpp +++ b/src/analysis/processing/qgsalgorithmextenttolayer.cpp @@ -37,6 +37,11 @@ QString QgsExtentToLayerAlgorithm::shortHelpString() const "a layer based input." ); } +QString QgsExtentToLayerAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that contains a single feature with geometry matching an extent parameter." ); +} + QgsExtentToLayerAlgorithm *QgsExtentToLayerAlgorithm::createInstance() const { return new QgsExtentToLayerAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmextenttolayer.h b/src/analysis/processing/qgsalgorithmextenttolayer.h index cbf8da58e83..53ed6a3f10f 100644 --- a/src/analysis/processing/qgsalgorithmextenttolayer.h +++ b/src/analysis/processing/qgsalgorithmextenttolayer.h @@ -39,6 +39,7 @@ class QgsExtentToLayerAlgorithm : public QgsProcessingAlgorithm QString group() const override { return QObject::tr( "Vector geometry" ); } QString groupId() const override { return QStringLiteral( "vectorgeometry" ); } QString shortHelpString() const override; + QString shortDescription() const override; QgsExtentToLayerAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextractbinary.cpp b/src/analysis/processing/qgsalgorithmextractbinary.cpp index 670c2488308..ea0480a5427 100644 --- a/src/analysis/processing/qgsalgorithmextractbinary.cpp +++ b/src/analysis/processing/qgsalgorithmextractbinary.cpp @@ -39,7 +39,7 @@ QString QgsExtractBinaryFieldAlgorithm::shortHelpString() const QString QgsExtractBinaryFieldAlgorithm::shortDescription() const { - return QObject::tr( "This algorithm extracts contents from a binary field, saving them to individual files." ); + return QObject::tr( "Extracts contents from a binary field, saving them to individual files." ); } QStringList QgsExtractBinaryFieldAlgorithm::tags() const diff --git a/src/analysis/processing/qgsalgorithmextractbyattribute.cpp b/src/analysis/processing/qgsalgorithmextractbyattribute.cpp index 2e05d06e4d3..bbd4aee4e4b 100644 --- a/src/analysis/processing/qgsalgorithmextractbyattribute.cpp +++ b/src/analysis/processing/qgsalgorithmextractbyattribute.cpp @@ -64,6 +64,11 @@ QString QgsExtractByAttributeAlgorithm::shortHelpString() const "of an attribute from the input layer." ); } +QString QgsExtractByAttributeAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that only contains feature matching an attribute value from an input layer." ); +} + QgsExtractByAttributeAlgorithm *QgsExtractByAttributeAlgorithm::createInstance() const { return new QgsExtractByAttributeAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmextractbyattribute.h b/src/analysis/processing/qgsalgorithmextractbyattribute.h index 3a97e24a1f6..95fb3207ee9 100644 --- a/src/analysis/processing/qgsalgorithmextractbyattribute.h +++ b/src/analysis/processing/qgsalgorithmextractbyattribute.h @@ -54,6 +54,7 @@ class QgsExtractByAttributeAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExtractByAttributeAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextractbyexpression.cpp b/src/analysis/processing/qgsalgorithmextractbyexpression.cpp index 79dc1a9d3a3..167223060ee 100644 --- a/src/analysis/processing/qgsalgorithmextractbyexpression.cpp +++ b/src/analysis/processing/qgsalgorithmextractbyexpression.cpp @@ -63,6 +63,11 @@ QString QgsExtractByExpressionAlgorithm::shortHelpString() const "which is available in the expression builder." ); } +QString QgsExtractByExpressionAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that only contains features matching a QGIS expression from an input layer." ); +} + QgsExtractByExpressionAlgorithm *QgsExtractByExpressionAlgorithm::createInstance() const { return new QgsExtractByExpressionAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmextractbyexpression.h b/src/analysis/processing/qgsalgorithmextractbyexpression.h index d7c784044d3..435c62fe501 100644 --- a/src/analysis/processing/qgsalgorithmextractbyexpression.h +++ b/src/analysis/processing/qgsalgorithmextractbyexpression.h @@ -39,6 +39,7 @@ class QgsExtractByExpressionAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExtractByExpressionAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextractbyextent.cpp b/src/analysis/processing/qgsalgorithmextractbyextent.cpp index 5d1aabb896e..b6d3446c58b 100644 --- a/src/analysis/processing/qgsalgorithmextractbyextent.cpp +++ b/src/analysis/processing/qgsalgorithmextractbyextent.cpp @@ -59,6 +59,11 @@ QString QgsExtractByExtentAlgorithm::shortHelpString() const "geometries will automatically be converted to multi geometries to ensure uniform output geometry types." ); } +QString QgsExtractByExtentAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that only contains features which intersect a specified extent." ); +} + QgsExtractByExtentAlgorithm *QgsExtractByExtentAlgorithm::createInstance() const { return new QgsExtractByExtentAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmextractbyextent.h b/src/analysis/processing/qgsalgorithmextractbyextent.h index 7de7e7bf8d9..6b630ea0fd8 100644 --- a/src/analysis/processing/qgsalgorithmextractbyextent.h +++ b/src/analysis/processing/qgsalgorithmextractbyextent.h @@ -39,6 +39,7 @@ class QgsExtractByExtentAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExtractByExtentAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextractbylocation.cpp b/src/analysis/processing/qgsalgorithmextractbylocation.cpp index 339a901a37e..75eaf7005fa 100644 --- a/src/analysis/processing/qgsalgorithmextractbylocation.cpp +++ b/src/analysis/processing/qgsalgorithmextractbylocation.cpp @@ -390,6 +390,11 @@ QString QgsSelectByLocationAlgorithm::shortHelpString() const "features is based on the spatial relationship between each feature and the features in an additional layer." ); } +QString QgsSelectByLocationAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a selection in a vector layer based on the spatial relationship with features in an additional layer." ); +} + QgsSelectByLocationAlgorithm *QgsSelectByLocationAlgorithm::createInstance() const { return new QgsSelectByLocationAlgorithm(); @@ -490,6 +495,11 @@ QString QgsExtractByLocationAlgorithm::shortHelpString() const "based on the spatial relationship between each feature and the features in an additional layer." ); } +QString QgsExtractByLocationAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that only contains features matching a spatial relationship with the features in an additional layer." ); +} + QgsExtractByLocationAlgorithm *QgsExtractByLocationAlgorithm::createInstance() const { return new QgsExtractByLocationAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmextractbylocation.h b/src/analysis/processing/qgsalgorithmextractbylocation.h index 2a6a3b239f5..e3ff1bad9b5 100644 --- a/src/analysis/processing/qgsalgorithmextractbylocation.h +++ b/src/analysis/processing/qgsalgorithmextractbylocation.h @@ -78,6 +78,7 @@ class QgsSelectByLocationAlgorithm : public QgsLocationBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsSelectByLocationAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -98,6 +99,7 @@ class QgsExtractByLocationAlgorithm : public QgsLocationBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsExtractByLocationAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmextractspecificvertices.cpp b/src/analysis/processing/qgsalgorithmextractspecificvertices.cpp index fd94b84c26c..9542d38627d 100644 --- a/src/analysis/processing/qgsalgorithmextractspecificvertices.cpp +++ b/src/analysis/processing/qgsalgorithmextractspecificvertices.cpp @@ -62,6 +62,11 @@ QString QgsExtractSpecificVerticesAlgorithm::shortHelpString() const "polygons), distance along the original geometry and bisector angle of vertex for the original geometry." ); } +QString QgsExtractSpecificVerticesAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a point layer with points representing specific vertices in the input geometries." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsExtractSpecificVerticesAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmextractspecificvertices.h b/src/analysis/processing/qgsalgorithmextractspecificvertices.h index c5f18fee68b..e3ea8f5343c 100644 --- a/src/analysis/processing/qgsalgorithmextractspecificvertices.h +++ b/src/analysis/processing/qgsalgorithmextractspecificvertices.h @@ -39,6 +39,7 @@ class QgsExtractSpecificVerticesAlgorithm : public QgsProcessingFeatureBasedAlgo QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; QgsExtractSpecificVerticesAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmextractvertices.cpp b/src/analysis/processing/qgsalgorithmextractvertices.cpp index 6ac50726b32..85616e8a55a 100644 --- a/src/analysis/processing/qgsalgorithmextractvertices.cpp +++ b/src/analysis/processing/qgsalgorithmextractvertices.cpp @@ -52,6 +52,11 @@ QString QgsExtractVerticesAlgorithm::shortHelpString() const return QObject::tr( "This algorithm takes a vector layer and generates a point layer with points representing the vertices in the input geometries. The attributes associated to each point are the same ones associated to the feature that the point belongs to." ) + QStringLiteral( "\n\n" ) + QObject::tr( "Additional fields are added to the point indicating the vertex index (beginning at 0), the vertex’s part and its index within the part (as well as its ring for polygons), distance along original geometry and bisector angle of vertex for original geometry." ); } +QString QgsExtractVerticesAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a point layer with points representing the vertices in the input geometries." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsExtractVerticesAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmextractvertices.h b/src/analysis/processing/qgsalgorithmextractvertices.h index 1884d4bcc82..74da156c6d3 100644 --- a/src/analysis/processing/qgsalgorithmextractvertices.h +++ b/src/analysis/processing/qgsalgorithmextractvertices.h @@ -41,6 +41,7 @@ class QgsExtractVerticesAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsExtractVerticesAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmfieldcalculator.cpp b/src/analysis/processing/qgsalgorithmfieldcalculator.cpp index 22f7cbeac88..0fddf5820ee 100644 --- a/src/analysis/processing/qgsalgorithmfieldcalculator.cpp +++ b/src/analysis/processing/qgsalgorithmfieldcalculator.cpp @@ -122,6 +122,12 @@ QString QgsFieldCalculatorAlgorithm::shortHelpString() const "Note that if \"Field name\" is an existing field in the layer then all the rest of the field settings are ignored." ); } +QString QgsFieldCalculatorAlgorithm::shortDescription() const +{ + return QObject::tr( "Computes a new vector layer with the same features of the input layer, " + "but either overwriting an existing attribute or adding an additional attribute." ); +} + QgsFieldCalculatorAlgorithm *QgsFieldCalculatorAlgorithm::createInstance() const { return new QgsFieldCalculatorAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmfieldcalculator.h b/src/analysis/processing/qgsalgorithmfieldcalculator.h index 786b2a03e5e..203e857ebdf 100644 --- a/src/analysis/processing/qgsalgorithmfieldcalculator.h +++ b/src/analysis/processing/qgsalgorithmfieldcalculator.h @@ -40,6 +40,7 @@ class QgsFieldCalculatorAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QList inputLayerTypes() const override; QgsFieldCalculatorAlgorithm *createInstance() const override SIP_FACTORY; bool supportInPlaceEdit( const QgsMapLayer *layer ) const override; diff --git a/src/analysis/processing/qgsalgorithmfillnodata.cpp b/src/analysis/processing/qgsalgorithmfillnodata.cpp index 23ecab89775..92d4b61d02a 100644 --- a/src/analysis/processing/qgsalgorithmfillnodata.cpp +++ b/src/analysis/processing/qgsalgorithmfillnodata.cpp @@ -75,6 +75,11 @@ QString QgsFillNoDataAlgorithm::shortHelpString() const "when applied to an integer raster)." ); } +QString QgsFillNoDataAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a raster dataset with the NoData values in the input raster reset to a given value." ); +} + QgsFillNoDataAlgorithm *QgsFillNoDataAlgorithm::createInstance() const { return new QgsFillNoDataAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmfillnodata.h b/src/analysis/processing/qgsalgorithmfillnodata.h index 34bb56e0508..8e375d97b81 100644 --- a/src/analysis/processing/qgsalgorithmfillnodata.h +++ b/src/analysis/processing/qgsalgorithmfillnodata.h @@ -45,6 +45,7 @@ class QgsFillNoDataAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFillNoDataAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmfillsinkswangliu.cpp b/src/analysis/processing/qgsalgorithmfillsinkswangliu.cpp index a138d1d2fb5..9809237b7dc 100644 --- a/src/analysis/processing/qgsalgorithmfillsinkswangliu.cpp +++ b/src/analysis/processing/qgsalgorithmfillsinkswangliu.cpp @@ -59,6 +59,11 @@ QString QgsFillSinksWangLiuAlgorithm::shortHelpString() const "This algorithm is a port of the SAGA 'Fill Sinks (Wang & Liu)' tool." ); } +QString QgsFillSinksWangLiuAlgorithm::shortDescription() const +{ + return QObject::tr( "Identifies and fills surface depressions in digital elevation models using a method proposed by Wang & Liu." ); +} + void QgsFillSinksWangLiuAlgorithm::initAlgorithm( const QVariantMap & ) { addParameter( new QgsProcessingParameterRasterLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) ); diff --git a/src/analysis/processing/qgsalgorithmfillsinkswangliu.h b/src/analysis/processing/qgsalgorithmfillsinkswangliu.h index 7d8ac649bcc..0e3dac8cb05 100644 --- a/src/analysis/processing/qgsalgorithmfillsinkswangliu.h +++ b/src/analysis/processing/qgsalgorithmfillsinkswangliu.h @@ -38,6 +38,7 @@ class QgsFillSinksWangLiuAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override; QgsFillSinksWangLiuAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmfilter.cpp b/src/analysis/processing/qgsalgorithmfilter.cpp index aa863fd3d2b..cc4c482bc54 100644 --- a/src/analysis/processing/qgsalgorithmfilter.cpp +++ b/src/analysis/processing/qgsalgorithmfilter.cpp @@ -55,6 +55,11 @@ QString QgsFilterAlgorithm::shortHelpString() const return QObject::tr( "This algorithm filters features from the input layer and redirects them to one or several outputs." ); } +QString QgsFilterAlgorithm::shortDescription() const +{ + return QObject::tr( "Filters features from the input layer and redirects them to one or several outputs." ); +} + QgsFilterAlgorithm *QgsFilterAlgorithm::createInstance() const { return new QgsFilterAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmfilter.h b/src/analysis/processing/qgsalgorithmfilter.h index d65a65c45bf..fff32420757 100644 --- a/src/analysis/processing/qgsalgorithmfilter.h +++ b/src/analysis/processing/qgsalgorithmfilter.h @@ -49,6 +49,7 @@ class QgsFilterAlgorithm : public QgsProcessingAlgorithm QString groupId() const override; Qgis::ProcessingAlgorithmFlags flags() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFilterAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmfiltervertices.cpp b/src/analysis/processing/qgsalgorithmfiltervertices.cpp index b489ff0b0b0..e58ed1fae88 100644 --- a/src/analysis/processing/qgsalgorithmfiltervertices.cpp +++ b/src/analysis/processing/qgsalgorithmfiltervertices.cpp @@ -48,6 +48,12 @@ QString QgsFilterVerticesAlgorithmBase::shortHelpString() const .arg( componentString() ); } +QString QgsFilterVerticesAlgorithmBase::shortDescription() const +{ + return QObject::tr( "Filters away vertices based on their %1 value." ) + .arg( componentString() ); +} + void QgsFilterVerticesAlgorithmBase::initParameters( const QVariantMap & ) { auto min = std::make_unique( QStringLiteral( "MIN" ), QObject::tr( "Minimum" ), Qgis::ProcessingNumberParameterType::Double, QVariant(), true ); diff --git a/src/analysis/processing/qgsalgorithmfiltervertices.h b/src/analysis/processing/qgsalgorithmfiltervertices.h index 3ed9777063e..972d4405a06 100644 --- a/src/analysis/processing/qgsalgorithmfiltervertices.h +++ b/src/analysis/processing/qgsalgorithmfiltervertices.h @@ -36,6 +36,7 @@ class QgsFilterVerticesAlgorithmBase : public QgsProcessingFeatureBasedAlgorithm QString groupId() const override final; void initParameters( const QVariantMap &configuration = QVariantMap() ) override final; QString shortHelpString() const override final; + QString shortDescription() const override; protected: QString outputName() const override final; diff --git a/src/analysis/processing/qgsalgorithmfixgeometries.cpp b/src/analysis/processing/qgsalgorithmfixgeometries.cpp index 14951a4597b..0490c7f578a 100644 --- a/src/analysis/processing/qgsalgorithmfixgeometries.cpp +++ b/src/analysis/processing/qgsalgorithmfixgeometries.cpp @@ -70,6 +70,11 @@ QString QgsFixGeometriesAlgorithm::shortHelpString() const "NOTE: M values will be dropped from the output." ); } +QString QgsFixGeometriesAlgorithm::shortDescription() const +{ + return QObject::tr( "Attempts to create a valid representation of a given invalid geometry without losing any of the input vertices." ); +} + QgsFixGeometriesAlgorithm *QgsFixGeometriesAlgorithm::createInstance() const { return new QgsFixGeometriesAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmfixgeometries.h b/src/analysis/processing/qgsalgorithmfixgeometries.h index 7d33b9382f7..a68892c5d7f 100644 --- a/src/analysis/processing/qgsalgorithmfixgeometries.h +++ b/src/analysis/processing/qgsalgorithmfixgeometries.h @@ -38,6 +38,7 @@ class QgsFixGeometriesAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFixGeometriesAlgorithm *createInstance() const override SIP_FACTORY; bool supportInPlaceEdit( const QgsMapLayer *layer ) const override; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmfuzzifyraster.cpp b/src/analysis/processing/qgsalgorithmfuzzifyraster.cpp index 687420d62ea..90c90ab710b 100644 --- a/src/analysis/processing/qgsalgorithmfuzzifyraster.cpp +++ b/src/analysis/processing/qgsalgorithmfuzzifyraster.cpp @@ -152,10 +152,15 @@ QStringList QgsFuzzifyRasterLinearMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,linear,membership" ).split( ',' ); } +QString QgsFuzzifyRasterLinearMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following a " + "linear fuzzy membership function." ); +} QString QgsFuzzifyRasterLinearMembershipAlgorithm::shortHelpString() const { - return QObject::tr( "The Fuzzify raster (linear membership) algorithm transforms an input raster " + return QObject::tr( "This algorithm transforms an input raster " "to a fuzzified raster and thereby assigns values between 0 and 1 following a " "linear fuzzy membership function. The value of 0 implies no membership with the " "defined fuzzy set, a value of 1 depicts full membership. In between, the degree " @@ -278,10 +283,15 @@ QStringList QgsFuzzifyRasterPowerMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,power,non-linear,membership,exponent" ).split( ',' ); } +QString QgsFuzzifyRasterPowerMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following a " + "power function." ); +} QString QgsFuzzifyRasterPowerMembershipAlgorithm::shortHelpString() const { - return QObject::tr( "The Fuzzify raster (power membership) algorithm transforms an input raster " + return QObject::tr( "This algorithm transforms an input raster " "to a fuzzified raster and thereby assigns values between 0 and 1 following a " "power function. The value of 0 implies no membership with the " "defined fuzzy set, a value of 1 depicts full membership. In between, the degree " @@ -406,10 +416,15 @@ QStringList QgsFuzzifyRasterLargeMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,large,membership" ).split( ',' ); } +QString QgsFuzzifyRasterLargeMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following the " + "'large' fuzzy membership function." ); +} QString QgsFuzzifyRasterLargeMembershipAlgorithm::shortHelpString() const { - return QObject::tr( "The Fuzzify raster (large membership) algorithm transforms an input raster " + return QObject::tr( "This algorithm transforms an input raster " "to a fuzzified raster and thereby assigns values between 0 and 1 following the " "'large' fuzzy membership function. The value of 0 implies no membership with the " "defined fuzzy set, a value of 1 depicts full membership. In between, the degree " @@ -513,6 +528,11 @@ QStringList QgsFuzzifyRasterSmallMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,small,membership" ).split( ',' ); } +QString QgsFuzzifyRasterSmallMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following the " + "'small' fuzzy membership function." ); +} QString QgsFuzzifyRasterSmallMembershipAlgorithm::shortHelpString() const { @@ -620,10 +640,15 @@ QStringList QgsFuzzifyRasterGaussianMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,gaussian,membership" ).split( ',' ); } +QString QgsFuzzifyRasterGaussianMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following a " + "gaussian fuzzy membership function." ); +} QString QgsFuzzifyRasterGaussianMembershipAlgorithm::shortHelpString() const { - return QObject::tr( "The Fuzzify raster (gaussian membership) algorithm transforms an input raster " + return QObject::tr( "This algorithm transforms an input raster " "to a fuzzified raster and thereby assigns values between 0 and 1 following a " "gaussian fuzzy membership function. The value of 0 implies no membership with the " "defined fuzzy set, a value of 1 depicts full membership. In between, the degree " @@ -727,6 +752,11 @@ QStringList QgsFuzzifyRasterNearMembershipAlgorithm::tags() const return QObject::tr( "fuzzy logic,fuzzify,fuzzy,logic,near,membership" ).split( ',' ); } +QString QgsFuzzifyRasterNearMembershipAlgorithm::shortDescription() const +{ + return QObject::tr( "Transforms an input raster to a fuzzified raster where values range from 0 to 1 following the " + "'near' fuzzy membership function." ); +} QString QgsFuzzifyRasterNearMembershipAlgorithm::shortHelpString() const { diff --git a/src/analysis/processing/qgsalgorithmfuzzifyraster.h b/src/analysis/processing/qgsalgorithmfuzzifyraster.h index 02ad0c23ca3..ce953410a4e 100644 --- a/src/analysis/processing/qgsalgorithmfuzzifyraster.h +++ b/src/analysis/processing/qgsalgorithmfuzzifyraster.h @@ -84,6 +84,7 @@ class QgsFuzzifyRasterLinearMembershipAlgorithm : public QgsFuzzifyRasterAlgorit QString name() const override; QString displayName() const override; QStringList tags() const override; + QString shortDescription() const override; QString shortHelpString() const override; QgsFuzzifyRasterLinearMembershipAlgorithm *createInstance() const override SIP_FACTORY; @@ -107,6 +108,7 @@ class QgsFuzzifyRasterPowerMembershipAlgorithm : public QgsFuzzifyRasterAlgorith QString name() const override; QString displayName() const override; QStringList tags() const override; + QString shortDescription() const override; QString shortHelpString() const override; QgsFuzzifyRasterPowerMembershipAlgorithm *createInstance() const override SIP_FACTORY; @@ -132,6 +134,7 @@ class QgsFuzzifyRasterLargeMembershipAlgorithm : public QgsFuzzifyRasterAlgorith QString displayName() const override; QStringList tags() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFuzzifyRasterLargeMembershipAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -155,6 +158,7 @@ class QgsFuzzifyRasterSmallMembershipAlgorithm : public QgsFuzzifyRasterAlgorith QString displayName() const override; QStringList tags() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFuzzifyRasterSmallMembershipAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -178,6 +182,7 @@ class QgsFuzzifyRasterGaussianMembershipAlgorithm : public QgsFuzzifyRasterAlgor QString displayName() const override; QStringList tags() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFuzzifyRasterGaussianMembershipAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -201,6 +206,7 @@ class QgsFuzzifyRasterNearMembershipAlgorithm : public QgsFuzzifyRasterAlgorithm QString displayName() const override; QStringList tags() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsFuzzifyRasterNearMembershipAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmgenerateelevationprofile.cpp b/src/analysis/processing/qgsalgorithmgenerateelevationprofile.cpp index 74aff4336bf..be882427491 100644 --- a/src/analysis/processing/qgsalgorithmgenerateelevationprofile.cpp +++ b/src/analysis/processing/qgsalgorithmgenerateelevationprofile.cpp @@ -157,6 +157,11 @@ QString QgsGenerateElevationProfileAlgorithm::shortHelpString() const return QObject::tr( "This algorithm creates an elevation profile image from a list of map layer and an optional terrain." ); } +QString QgsGenerateElevationProfileAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates an elevation profile image from a list of map layer and an optional terrain." ); +} + QgsGenerateElevationProfileAlgorithm *QgsGenerateElevationProfileAlgorithm::createInstance() const { return new QgsGenerateElevationProfileAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmgenerateelevationprofile.h b/src/analysis/processing/qgsalgorithmgenerateelevationprofile.h index 736054f4c4b..79d404d197d 100644 --- a/src/analysis/processing/qgsalgorithmgenerateelevationprofile.h +++ b/src/analysis/processing/qgsalgorithmgenerateelevationprofile.h @@ -43,6 +43,7 @@ class QgsGenerateElevationProfileAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsGenerateElevationProfileAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmgeometrybyexpression.cpp b/src/analysis/processing/qgsalgorithmgeometrybyexpression.cpp index a6b754e2698..6fee44ff0d6 100644 --- a/src/analysis/processing/qgsalgorithmgeometrybyexpression.cpp +++ b/src/analysis/processing/qgsalgorithmgeometrybyexpression.cpp @@ -60,6 +60,12 @@ QString QgsGeometryByExpressionAlgorithm::shortHelpString() const "which is available in the expression builder." ); } +QString QgsGeometryByExpressionAlgorithm::shortDescription() const +{ + return QObject::tr( "Updates existing geometries (or creates new geometries) for input " + "features by use of a QGIS expression." ); +} + QgsGeometryByExpressionAlgorithm *QgsGeometryByExpressionAlgorithm::createInstance() const { return new QgsGeometryByExpressionAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmgeometrybyexpression.h b/src/analysis/processing/qgsalgorithmgeometrybyexpression.h index 2267190ad96..cbbae21a01b 100644 --- a/src/analysis/processing/qgsalgorithmgeometrybyexpression.h +++ b/src/analysis/processing/qgsalgorithmgeometrybyexpression.h @@ -42,6 +42,7 @@ class QgsGeometryByExpressionAlgorithm : public QgsProcessingFeatureBasedAlgorit QString groupId() const override; QString shortHelpString() const override; QList inputLayerTypes() const override; + QString shortDescription() const override; QgsGeometryByExpressionAlgorithm *createInstance() const override SIP_FACTORY; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmgltftovector.cpp b/src/analysis/processing/qgsalgorithmgltftovector.cpp index 6fb09ddc838..89cc625c1d8 100644 --- a/src/analysis/processing/qgsalgorithmgltftovector.cpp +++ b/src/analysis/processing/qgsalgorithmgltftovector.cpp @@ -59,6 +59,11 @@ QString QgsGltfToVectorFeaturesAlgorithm::groupId() const } QString QgsGltfToVectorFeaturesAlgorithm::shortHelpString() const +{ + return QObject::tr( "This algorithm converts GLTF content to standard vector layer formats." ); +} + +QString QgsGltfToVectorFeaturesAlgorithm::shortDescription() const { return QObject::tr( "Converts GLTF content to standard vector layer formats." ); } diff --git a/src/analysis/processing/qgsalgorithmgltftovector.h b/src/analysis/processing/qgsalgorithmgltftovector.h index b0d108d45ec..dda08a7fa63 100644 --- a/src/analysis/processing/qgsalgorithmgltftovector.h +++ b/src/analysis/processing/qgsalgorithmgltftovector.h @@ -39,6 +39,7 @@ class QgsGltfToVectorFeaturesAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsGltfToVectorFeaturesAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmgpsbabeltools.cpp b/src/analysis/processing/qgsalgorithmgpsbabeltools.cpp index 6f0c6f52d1a..a9c48f0e865 100644 --- a/src/analysis/processing/qgsalgorithmgpsbabeltools.cpp +++ b/src/analysis/processing/qgsalgorithmgpsbabeltools.cpp @@ -83,6 +83,11 @@ QString QgsConvertGpxFeatureTypeAlgorithm::shortHelpString() const return QObject::tr( "This algorithm uses the GPSBabel tool to convert GPX features from one type to another (e.g. converting all waypoint features to a route feature)." ); } +QString QgsConvertGpxFeatureTypeAlgorithm::shortDescription() const +{ + return QObject::tr( "Converts GPX features from one type to another." ); +} + QgsConvertGpxFeatureTypeAlgorithm *QgsConvertGpxFeatureTypeAlgorithm::createInstance() const { return new QgsConvertGpxFeatureTypeAlgorithm(); @@ -284,6 +289,11 @@ QString QgsConvertGpsDataAlgorithm::shortHelpString() const return QObject::tr( "This algorithm uses the GPSBabel tool to convert a GPS data file from a range of formats to the GPX standard format." ); } +QString QgsConvertGpsDataAlgorithm::shortDescription() const +{ + return QObject::tr( "Converts a GPS data file from a range of formats to the GPX standard format." ); +} + QgsConvertGpsDataAlgorithm *QgsConvertGpsDataAlgorithm::createInstance() const { return new QgsConvertGpsDataAlgorithm(); @@ -487,6 +497,11 @@ QString QgsDownloadGpsDataAlgorithm::shortHelpString() const return QObject::tr( "This algorithm uses the GPSBabel tool to download data from a GPS device into the GPX standard format." ); } +QString QgsDownloadGpsDataAlgorithm::shortDescription() const +{ + return QObject::tr( "Downloads data from a GPS device into the GPX standard format." ); +} + QgsDownloadGpsDataAlgorithm *QgsDownloadGpsDataAlgorithm::createInstance() const { return new QgsDownloadGpsDataAlgorithm(); @@ -701,6 +716,11 @@ QString QgsUploadGpsDataAlgorithm::shortHelpString() const return QObject::tr( "This algorithm uses the GPSBabel tool to upload data to a GPS device from the GPX standard format." ); } +QString QgsUploadGpsDataAlgorithm::shortDescription() const +{ + return QObject::tr( "Uploads data to a GPS device from the GPX standard format." ); +} + QgsUploadGpsDataAlgorithm *QgsUploadGpsDataAlgorithm::createInstance() const { return new QgsUploadGpsDataAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmgpsbabeltools.h b/src/analysis/processing/qgsalgorithmgpsbabeltools.h index 3425cc2f77e..2babdde46f3 100644 --- a/src/analysis/processing/qgsalgorithmgpsbabeltools.h +++ b/src/analysis/processing/qgsalgorithmgpsbabeltools.h @@ -48,6 +48,7 @@ class ANALYSIS_EXPORT QgsConvertGpxFeatureTypeAlgorithm : public QgsProcessingAl QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsConvertGpxFeatureTypeAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -93,6 +94,7 @@ class ANALYSIS_EXPORT QgsConvertGpsDataAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsConvertGpsDataAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -119,6 +121,7 @@ class ANALYSIS_EXPORT QgsDownloadGpsDataAlgorithm : public QgsProcessingAlgorith QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsDownloadGpsDataAlgorithm *createInstance() const override SIP_FACTORY; protected: @@ -145,6 +148,7 @@ class ANALYSIS_EXPORT QgsUploadGpsDataAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsUploadGpsDataAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmgrid.cpp b/src/analysis/processing/qgsalgorithmgrid.cpp index a95085d751c..d0417b3a12a 100644 --- a/src/analysis/processing/qgsalgorithmgrid.cpp +++ b/src/analysis/processing/qgsalgorithmgrid.cpp @@ -80,6 +80,10 @@ QString QgsGridAlgorithm::shortHelpString() const "selected spacing, that is not true for the other points that define that extent." ); } +QString QgsGridAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer with a grid covering a given extent." ); +} QgsGridAlgorithm *QgsGridAlgorithm::createInstance() const { diff --git a/src/analysis/processing/qgsalgorithmgrid.h b/src/analysis/processing/qgsalgorithmgrid.h index a3ef54d8871..4fb1753e421 100644 --- a/src/analysis/processing/qgsalgorithmgrid.h +++ b/src/analysis/processing/qgsalgorithmgrid.h @@ -45,6 +45,7 @@ class QgsGridAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsGridAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmhillshade.cpp b/src/analysis/processing/qgsalgorithmhillshade.cpp index e5479578229..1cacb621391 100644 --- a/src/analysis/processing/qgsalgorithmhillshade.cpp +++ b/src/analysis/processing/qgsalgorithmhillshade.cpp @@ -53,6 +53,11 @@ QString QgsHillshadeAlgorithm::shortHelpString() const + QObject::tr( "The shading of the layer is calculated according to the sun position (azimuth and elevation)." ); } +QString QgsHillshadeAlgorithm::shortDescription() const +{ + return QObject::tr( "Calculates the hillshade of the Digital Terrain Model in input." ); +} + QgsHillshadeAlgorithm *QgsHillshadeAlgorithm::createInstance() const { return new QgsHillshadeAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmhillshade.h b/src/analysis/processing/qgsalgorithmhillshade.h index a58140a6352..f0c39a5194d 100644 --- a/src/analysis/processing/qgsalgorithmhillshade.h +++ b/src/analysis/processing/qgsalgorithmhillshade.h @@ -39,6 +39,7 @@ class QgsHillshadeAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsHillshadeAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmimportphotos.cpp b/src/analysis/processing/qgsalgorithmimportphotos.cpp index 57f4e8bea47..0350fdfbf3a 100644 --- a/src/analysis/processing/qgsalgorithmimportphotos.cpp +++ b/src/analysis/processing/qgsalgorithmimportphotos.cpp @@ -65,12 +65,17 @@ void QgsImportPhotosAlgorithm::initAlgorithm( const QVariantMap & ) QString QgsImportPhotosAlgorithm::shortHelpString() const { - return QObject::tr( "Creates a point layer corresponding to the geotagged locations from JPEG or HEIF/HEIC images from a source folder. Optionally the folder can be recursively scanned.\n\n" + return QObject::tr( "This algorithm creates a point layer corresponding to the geotagged locations from JPEG or HEIF/HEIC images from a source folder. Optionally the folder can be recursively scanned.\n\n" "The point layer will contain a single PointZ feature per input file from which the geotags could be read. Any altitude information from the geotags will be used " "to set the point's Z value.\n\n" "Optionally, a table of unreadable or non-geotagged photos can also be created." ); } +QString QgsImportPhotosAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a point layer corresponding to the geotagged locations from JPEG or HEIF/HEIC images from a source folder." ); +} + QgsImportPhotosAlgorithm *QgsImportPhotosAlgorithm::createInstance() const { return new QgsImportPhotosAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmimportphotos.h b/src/analysis/processing/qgsalgorithmimportphotos.h index c80504f5e7e..edfbb77889c 100644 --- a/src/analysis/processing/qgsalgorithmimportphotos.h +++ b/src/analysis/processing/qgsalgorithmimportphotos.h @@ -40,6 +40,7 @@ class ANALYSIS_EXPORT QgsImportPhotosAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsImportPhotosAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmintersection.cpp b/src/analysis/processing/qgsalgorithmintersection.cpp index 1ea7dc665cb..20e71742e84 100644 --- a/src/analysis/processing/qgsalgorithmintersection.cpp +++ b/src/analysis/processing/qgsalgorithmintersection.cpp @@ -49,6 +49,11 @@ QString QgsIntersectionAlgorithm::shortHelpString() const "from both the Input and Overlay layers." ); } +QString QgsIntersectionAlgorithm::shortDescription() const +{ + return QObject::tr( "Extracts overlapping portions of features between two layers." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsIntersectionAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmintersection.h b/src/analysis/processing/qgsalgorithmintersection.h index 368a56d5455..2acf6ada1d7 100644 --- a/src/analysis/processing/qgsalgorithmintersection.h +++ b/src/analysis/processing/qgsalgorithmintersection.h @@ -34,6 +34,7 @@ class QgsIntersectionAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; protected: diff --git a/src/analysis/processing/qgsalgorithmjoinbyattribute.cpp b/src/analysis/processing/qgsalgorithmjoinbyattribute.cpp index 4382b22e4ad..a1427d6a2f3 100644 --- a/src/analysis/processing/qgsalgorithmjoinbyattribute.cpp +++ b/src/analysis/processing/qgsalgorithmjoinbyattribute.cpp @@ -85,6 +85,12 @@ QString QgsJoinByAttributeAlgorithm::shortHelpString() const "in each of them to define the join criteria." ); } +QString QgsJoinByAttributeAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that is an extended version of the input one, " + "with additional attributes taken from a second vector layer." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsJoinByAttributeAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmjoinbyattribute.h b/src/analysis/processing/qgsalgorithmjoinbyattribute.h index ad67a2589cc..4fd66f240b6 100644 --- a/src/analysis/processing/qgsalgorithmjoinbyattribute.h +++ b/src/analysis/processing/qgsalgorithmjoinbyattribute.h @@ -39,6 +39,7 @@ class QgsJoinByAttributeAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsJoinByAttributeAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmkeepnbiggestparts.cpp b/src/analysis/processing/qgsalgorithmkeepnbiggestparts.cpp index 4f1d47494b8..3d5f4024be5 100644 --- a/src/analysis/processing/qgsalgorithmkeepnbiggestparts.cpp +++ b/src/analysis/processing/qgsalgorithmkeepnbiggestparts.cpp @@ -69,6 +69,12 @@ QString QgsKeepNBiggestPartsAlgorithm::shortHelpString() const "geometries have been removed, leaving only the n largest (in terms of area) parts." ); } +QString QgsKeepNBiggestPartsAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a polygon layer in which multipart geometries have been removed, " + "leaving only the n largest (in terms of area) parts." ); +} + QgsKeepNBiggestPartsAlgorithm *QgsKeepNBiggestPartsAlgorithm::createInstance() const { return new QgsKeepNBiggestPartsAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmkeepnbiggestparts.h b/src/analysis/processing/qgsalgorithmkeepnbiggestparts.h index aaf25986ea3..4914cbc39b3 100644 --- a/src/analysis/processing/qgsalgorithmkeepnbiggestparts.h +++ b/src/analysis/processing/qgsalgorithmkeepnbiggestparts.h @@ -38,6 +38,7 @@ class QgsKeepNBiggestPartsAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsKeepNBiggestPartsAlgorithm *createInstance() const override SIP_FACTORY; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmkmeansclustering.cpp b/src/analysis/processing/qgsalgorithmkmeansclustering.cpp index 134652a0434..3f01fa3d1d6 100644 --- a/src/analysis/processing/qgsalgorithmkmeansclustering.cpp +++ b/src/analysis/processing/qgsalgorithmkmeansclustering.cpp @@ -64,10 +64,15 @@ void QgsKMeansClusteringAlgorithm::initAlgorithm( const QVariantMap & ) QString QgsKMeansClusteringAlgorithm::shortHelpString() const { - return QObject::tr( "Calculates the 2D distance based k-means cluster number for each input feature.\n\n" + return QObject::tr( "This algorithm calculates the 2D distance based k-means cluster number for each input feature.\n\n" "If input geometries are lines or polygons, the clustering is based on the centroid of the feature." ); } +QString QgsKMeansClusteringAlgorithm::shortDescription() const +{ + return QObject::tr( "Calculates the 2D distance based k-means cluster number for each input feature." ); +} + QgsKMeansClusteringAlgorithm *QgsKMeansClusteringAlgorithm::createInstance() const { return new QgsKMeansClusteringAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmkmeansclustering.h b/src/analysis/processing/qgsalgorithmkmeansclustering.h index b5c43602e7a..42b941ee601 100644 --- a/src/analysis/processing/qgsalgorithmkmeansclustering.h +++ b/src/analysis/processing/qgsalgorithmkmeansclustering.h @@ -41,6 +41,7 @@ class ANALYSIS_EXPORT QgsKMeansClusteringAlgorithm : public QgsProcessingAlgorit QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsKMeansClusteringAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmlinedensity.cpp b/src/analysis/processing/qgsalgorithmlinedensity.cpp index ef410005c9b..0004ab5df61 100644 --- a/src/analysis/processing/qgsalgorithmlinedensity.cpp +++ b/src/analysis/processing/qgsalgorithmlinedensity.cpp @@ -71,7 +71,7 @@ void QgsLineDensityAlgorithm::initAlgorithm( const QVariantMap & ) QString QgsLineDensityAlgorithm::shortHelpString() const { - return QObject::tr( "The line density interpolation algorithm calculates a density measure of linear features " + return QObject::tr( "This algorithm calculates a density measure of linear features " "which is obtained in a circular neighborhood within each raster cell. " "First, the length of the segment of each line that is intersected by the circular neighborhood " "is multiplied with the lines weight factor. In a second step, all length values are summed and " @@ -79,6 +79,12 @@ QString QgsLineDensityAlgorithm::shortHelpString() const ); } +QString QgsLineDensityAlgorithm::shortDescription() const +{ + return QObject::tr( "Calculates a density measure of linear features " + "which is obtained in a circular neighborhood within each raster cell." ); +} + QgsLineDensityAlgorithm *QgsLineDensityAlgorithm::createInstance() const { return new QgsLineDensityAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmlinedensity.h b/src/analysis/processing/qgsalgorithmlinedensity.h index 7a095c3992d..1a8ab3aff35 100644 --- a/src/analysis/processing/qgsalgorithmlinedensity.h +++ b/src/analysis/processing/qgsalgorithmlinedensity.h @@ -48,6 +48,7 @@ class QgsLineDensityAlgorithm : public QgsProcessingAlgorithm QStringList tags() const override; QString group() const override; QString groupId() const override; + QString shortDescription() const override; QString shortHelpString() const override; QgsLineDensityAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmlineintersection.cpp b/src/analysis/processing/qgsalgorithmlineintersection.cpp index 52e56ffefbd..7d20bd5bc20 100644 --- a/src/analysis/processing/qgsalgorithmlineintersection.cpp +++ b/src/analysis/processing/qgsalgorithmlineintersection.cpp @@ -76,6 +76,11 @@ QString QgsLineIntersectionAlgorithm::shortHelpString() const return QObject::tr( "This algorithm creates point features where the lines in the Intersect layer intersect the lines in the Input layer." ); } +QString QgsLineIntersectionAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates point features at the intersection of lines from two different layers." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsLineIntersectionAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmlineintersection.h b/src/analysis/processing/qgsalgorithmlineintersection.h index 3d81eb72e21..fb376cfc81a 100644 --- a/src/analysis/processing/qgsalgorithmlineintersection.h +++ b/src/analysis/processing/qgsalgorithmlineintersection.h @@ -41,6 +41,7 @@ class QgsLineIntersectionAlgorithm : public QgsProcessingAlgorithm QStringList tags() const override; QString group() const override; QString groupId() const override; + QString shortDescription() const override; QString shortHelpString() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsLineIntersectionAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmloadlayer.cpp b/src/analysis/processing/qgsalgorithmloadlayer.cpp index 3f3935518ac..d885f0cda57 100644 --- a/src/analysis/processing/qgsalgorithmloadlayer.cpp +++ b/src/analysis/processing/qgsalgorithmloadlayer.cpp @@ -54,6 +54,11 @@ QString QgsLoadLayerAlgorithm::shortHelpString() const return QObject::tr( "This algorithm loads a layer to the current project." ); } +QString QgsLoadLayerAlgorithm::shortDescription() const +{ + return QObject::tr( "Loads a layer to the current project." ); +} + QgsLoadLayerAlgorithm *QgsLoadLayerAlgorithm::createInstance() const { return new QgsLoadLayerAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmloadlayer.h b/src/analysis/processing/qgsalgorithmloadlayer.h index 56f3d491b1d..d5d8951cda4 100644 --- a/src/analysis/processing/qgsalgorithmloadlayer.h +++ b/src/analysis/processing/qgsalgorithmloadlayer.h @@ -41,6 +41,7 @@ class QgsLoadLayerAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsLoadLayerAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmmeancoordinates.cpp b/src/analysis/processing/qgsalgorithmmeancoordinates.cpp index 025fadbdd1a..bc7e85b8749 100644 --- a/src/analysis/processing/qgsalgorithmmeancoordinates.cpp +++ b/src/analysis/processing/qgsalgorithmmeancoordinates.cpp @@ -61,6 +61,11 @@ QString QgsMeanCoordinatesAlgorithm::shortHelpString() const "the output layer will contain a center of mass for the features in each category." ); } +QString QgsMeanCoordinatesAlgorithm::shortDescription() const +{ + return QObject::tr( "Computes a point layer with the center of mass of geometries in an input layer." ); +} + QgsMeanCoordinatesAlgorithm *QgsMeanCoordinatesAlgorithm::createInstance() const { return new QgsMeanCoordinatesAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmmeancoordinates.h b/src/analysis/processing/qgsalgorithmmeancoordinates.h index 14a73ba363b..89133b8e591 100644 --- a/src/analysis/processing/qgsalgorithmmeancoordinates.h +++ b/src/analysis/processing/qgsalgorithmmeancoordinates.h @@ -43,6 +43,7 @@ class QgsMeanCoordinatesAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsMeanCoordinatesAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmmergelines.cpp b/src/analysis/processing/qgsalgorithmmergelines.cpp index 6eec96e8212..e11550e9aa5 100644 --- a/src/analysis/processing/qgsalgorithmmergelines.cpp +++ b/src/analysis/processing/qgsalgorithmmergelines.cpp @@ -66,6 +66,11 @@ QString QgsMergeLinesAlgorithm::shortHelpString() const "geometry will be a MultiLineString containing any lines which could be merged and any non-connected line parts." ); } +QString QgsMergeLinesAlgorithm::shortDescription() const +{ + return QObject::tr( "Joins all connected parts of MultiLineString geometries into single LineString geometries." ); +} + QList QgsMergeLinesAlgorithm::inputLayerTypes() const { return QList() << static_cast( Qgis::ProcessingSourceType::VectorLine ); diff --git a/src/analysis/processing/qgsalgorithmmergelines.h b/src/analysis/processing/qgsalgorithmmergelines.h index 8a1e7308856..4efde2bdf6c 100644 --- a/src/analysis/processing/qgsalgorithmmergelines.h +++ b/src/analysis/processing/qgsalgorithmmergelines.h @@ -42,6 +42,7 @@ class QgsMergeLinesAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QList inputLayerTypes() const override; QgsMergeLinesAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.cpp b/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.cpp index c70c5376564..b1bad274968 100644 --- a/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.cpp +++ b/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.cpp @@ -31,7 +31,12 @@ QString QgsMeshSurfaceToPolygonAlgorithm::shortHelpString() const { - return QObject::tr( "This algorithm exports a polygon file containing mesh layer boundary. It may contain holes and it may be a multi-part polygon." ); + return QObject::tr( "This algorithm exports a polygon layer containing mesh layer boundary. It may contain holes and it may be a multi-part polygon." ); +} + +QString QgsMeshSurfaceToPolygonAlgorithm::shortDescription() const +{ + return QObject::tr( "Exports a polygon layer containing mesh layer boundary." ); } QString QgsMeshSurfaceToPolygonAlgorithm::name() const diff --git a/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.h b/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.h index 482d3c2b8df..08de661fc1d 100644 --- a/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.h +++ b/src/analysis/processing/qgsalgorithmmeshsurfacetopolygon.h @@ -30,6 +30,7 @@ class QgsMeshSurfaceToPolygonAlgorithm : public QgsProcessingAlgorithm { public: QgsMeshSurfaceToPolygonAlgorithm() = default; + QString shortDescription() const override; QString shortHelpString() const override; QString name() const override; QString displayName() const override; diff --git a/src/analysis/processing/qgsalgorithmminimumenclosingcircle.cpp b/src/analysis/processing/qgsalgorithmminimumenclosingcircle.cpp index a544a51a0f0..66eb9cd81ba 100644 --- a/src/analysis/processing/qgsalgorithmminimumenclosingcircle.cpp +++ b/src/analysis/processing/qgsalgorithmminimumenclosingcircle.cpp @@ -65,6 +65,11 @@ QString QgsMinimumEnclosingCircleAlgorithm::shortHelpString() const return QObject::tr( "This algorithm calculates the minimum enclosing circle which covers each feature in an input layer." ) + QStringLiteral( "\n\n" ) + QObject::tr( "See the 'Minimum bounding geometry' algorithm for a minimal enclosing circle calculation which covers the whole layer or grouped subsets of features." ); } +QString QgsMinimumEnclosingCircleAlgorithm::shortDescription() const +{ + return QObject::tr( "Calculates the minimum enclosing circle which covers each feature in an input layer." ); +} + QgsMinimumEnclosingCircleAlgorithm *QgsMinimumEnclosingCircleAlgorithm::createInstance() const { return new QgsMinimumEnclosingCircleAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmminimumenclosingcircle.h b/src/analysis/processing/qgsalgorithmminimumenclosingcircle.h index c5d96966471..c98c2c42290 100644 --- a/src/analysis/processing/qgsalgorithmminimumenclosingcircle.h +++ b/src/analysis/processing/qgsalgorithmminimumenclosingcircle.h @@ -38,6 +38,7 @@ class QgsMinimumEnclosingCircleAlgorithm : public QgsProcessingFeatureBasedAlgor QStringList tags() const override; QString group() const override; QString groupId() const override; + QString shortDescription() const override; QString shortHelpString() const override; QgsMinimumEnclosingCircleAlgorithm *createInstance() const override SIP_FACTORY; bool supportInPlaceEdit( const QgsMapLayer *layer ) const override; diff --git a/src/analysis/processing/qgsalgorithmmultidifference.cpp b/src/analysis/processing/qgsalgorithmmultidifference.cpp index 5381032e72a..fc496031af1 100644 --- a/src/analysis/processing/qgsalgorithmmultidifference.cpp +++ b/src/analysis/processing/qgsalgorithmmultidifference.cpp @@ -60,6 +60,11 @@ QString QgsMultiDifferenceAlgorithm::shortHelpString() const "be manually updated." ); } +QString QgsMultiDifferenceAlgorithm::shortDescription() const +{ + return QObject::tr( "Extracts features from a layer that fall completely outside or only partially overlap the features from other layer(s)." ); +} + QgsProcessingAlgorithm *QgsMultiDifferenceAlgorithm::createInstance() const { return new QgsMultiDifferenceAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmmultidifference.h b/src/analysis/processing/qgsalgorithmmultidifference.h index eeea1f16458..5fe48738248 100644 --- a/src/analysis/processing/qgsalgorithmmultidifference.h +++ b/src/analysis/processing/qgsalgorithmmultidifference.h @@ -36,6 +36,7 @@ class QgsMultiDifferenceAlgorithm : public QgsProcessingAlgorithm QStringList tags() const override; QString group() const override; QString groupId() const override; + QString shortDescription() const override; QString shortHelpString() const override; protected: diff --git a/src/analysis/processing/qgsalgorithmmultiintersection.cpp b/src/analysis/processing/qgsalgorithmmultiintersection.cpp index 2aa1ce177ec..4f72d12d8aa 100644 --- a/src/analysis/processing/qgsalgorithmmultiintersection.cpp +++ b/src/analysis/processing/qgsalgorithmmultiintersection.cpp @@ -55,6 +55,11 @@ QString QgsMultiIntersectionAlgorithm::shortHelpString() const "from both the Input and Overlay layers." ); } +QString QgsMultiIntersectionAlgorithm::shortDescription() const +{ + return QObject::tr( "Extracts portions of input features that overlap features from all other layers." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsMultiIntersectionAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmmultiintersection.h b/src/analysis/processing/qgsalgorithmmultiintersection.h index 2625ac3a9ca..e637154950a 100644 --- a/src/analysis/processing/qgsalgorithmmultiintersection.h +++ b/src/analysis/processing/qgsalgorithmmultiintersection.h @@ -37,6 +37,7 @@ class QgsMultiIntersectionAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; protected: diff --git a/src/analysis/processing/qgsalgorithmmultiparttosinglepart.cpp b/src/analysis/processing/qgsalgorithmmultiparttosinglepart.cpp index 41d08714ca0..cb2b8b89f5b 100644 --- a/src/analysis/processing/qgsalgorithmmultiparttosinglepart.cpp +++ b/src/analysis/processing/qgsalgorithmmultiparttosinglepart.cpp @@ -61,6 +61,11 @@ QString QgsMultipartToSinglepartAlgorithm::shortHelpString() const "a single part. Features with multipart geometries are divided in as many different features as parts the geometry " "contain, and the same attributes are used for each of them." ); } +QString QgsMultipartToSinglepartAlgorithm::shortDescription() const +{ + return QObject::tr( "Takes a vector layer with multipart geometries and generates a new one in which all geometries contain " + "a single part." ); +} Qgis::ProcessingAlgorithmDocumentationFlags QgsMultipartToSinglepartAlgorithm::documentationFlags() const { diff --git a/src/analysis/processing/qgsalgorithmmultiparttosinglepart.h b/src/analysis/processing/qgsalgorithmmultiparttosinglepart.h index 7bee85fe942..cbed9751134 100644 --- a/src/analysis/processing/qgsalgorithmmultiparttosinglepart.h +++ b/src/analysis/processing/qgsalgorithmmultiparttosinglepart.h @@ -43,6 +43,7 @@ class QgsMultipartToSinglepartAlgorithm : public QgsProcessingFeatureBasedAlgori QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsMultipartToSinglepartAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.cpp b/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.cpp index 6ecce875918..07fe3112b53 100644 --- a/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.cpp +++ b/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.cpp @@ -52,7 +52,12 @@ QString QgsMultiRingConstantBufferAlgorithm::outputName() const QString QgsMultiRingConstantBufferAlgorithm::shortHelpString() const { - return QObject::tr( "This algorithm computes multi-ring ('donuts') buffer for all the features in an input layer, using a fixed or dynamic distance and rings number." ); + return QObject::tr( "This algorithm computes multi-ring ('donuts') buffer for the features in an input layer, using a fixed or dynamic distance and rings number." ); +} + +QString QgsMultiRingConstantBufferAlgorithm::shortDescription() const +{ + return QObject::tr( "Computes multi-ring ('donuts') buffer using a fixed or dynamic distance and rings number." ); } Qgis::ProcessingAlgorithmDocumentationFlags QgsMultiRingConstantBufferAlgorithm::documentationFlags() const diff --git a/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.h b/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.h index ac95de869a8..067042cf312 100644 --- a/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.h +++ b/src/analysis/processing/qgsalgorithmmultiringconstantbuffer.h @@ -38,6 +38,7 @@ class QgsMultiRingConstantBufferAlgorithm : public QgsProcessingFeatureBasedAlgo QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsMultiRingConstantBufferAlgorithm *createInstance() const override SIP_FACTORY; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmmultiunion.cpp b/src/analysis/processing/qgsalgorithmmultiunion.cpp index 63bb82b73e6..c214a372f87 100644 --- a/src/analysis/processing/qgsalgorithmmultiunion.cpp +++ b/src/analysis/processing/qgsalgorithmmultiunion.cpp @@ -60,6 +60,11 @@ QString QgsMultiUnionAlgorithm::shortHelpString() const "for non-overlapping features, and attribute values from both layers for overlapping features." ); } +QString QgsMultiUnionAlgorithm::shortDescription() const +{ + return QObject::tr( "Checks overlaps between features and creates separate features for overlapping and non-overlapping parts." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsMultiUnionAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmmultiunion.h b/src/analysis/processing/qgsalgorithmmultiunion.h index 2b80b207da0..1ad5bbfda9c 100644 --- a/src/analysis/processing/qgsalgorithmmultiunion.h +++ b/src/analysis/processing/qgsalgorithmmultiunion.h @@ -37,6 +37,7 @@ class QgsMultiUnionAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; protected: diff --git a/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.cpp b/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.cpp index b8c121608a9..0f1d48fe9e2 100644 --- a/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.cpp +++ b/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.cpp @@ -55,6 +55,11 @@ QString QgsNearestNeighbourAnalysisAlgorithm::shortHelpString() const "Output is generated as an HTML file with the computed statistical values." ); } +QString QgsNearestNeighbourAnalysisAlgorithm::shortDescription() const +{ + return QObject::tr( "Performs nearest neighbor analysis for a point layer." ); +} + QString QgsNearestNeighbourAnalysisAlgorithm::svgIconPath() const { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmNearestNeighbour.svg" ) ); diff --git a/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.h b/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.h index f35fa832970..eae17791ef2 100644 --- a/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.h +++ b/src/analysis/processing/qgsalgorithmnearestneighbouranalysis.h @@ -38,6 +38,7 @@ class QgsNearestNeighbourAnalysisAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QString svgIconPath() const override; QIcon icon() const override; void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmorderbyexpression.cpp b/src/analysis/processing/qgsalgorithmorderbyexpression.cpp index 445fa402ae1..f360410399b 100644 --- a/src/analysis/processing/qgsalgorithmorderbyexpression.cpp +++ b/src/analysis/processing/qgsalgorithmorderbyexpression.cpp @@ -65,6 +65,11 @@ QString QgsOrderByExpressionAlgorithm::shortHelpString() const "which is available in the expression builder." ); } +QString QgsOrderByExpressionAlgorithm::shortDescription() const +{ + return QObject::tr( "Sorts a vector layer according to an expression." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsOrderByExpressionAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmorderbyexpression.h b/src/analysis/processing/qgsalgorithmorderbyexpression.h index 08763fa664d..3d595090af6 100644 --- a/src/analysis/processing/qgsalgorithmorderbyexpression.h +++ b/src/analysis/processing/qgsalgorithmorderbyexpression.h @@ -40,6 +40,7 @@ class QgsOrderByExpressionAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsOrderByExpressionAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.cpp b/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.cpp index 04133f22107..1e564dfbc5f 100644 --- a/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.cpp +++ b/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.cpp @@ -60,6 +60,11 @@ QString QgsOrientedMinimumBoundingBoxAlgorithm::shortHelpString() const return QObject::tr( "This algorithm calculates the minimum area rotated rectangle which covers each feature in an input layer." ) + QStringLiteral( "\n\n" ) + QObject::tr( "See the 'Minimum bounding geometry' algorithm for a oriented bounding box calculation which covers the whole layer or grouped subsets of features." ); } +QString QgsOrientedMinimumBoundingBoxAlgorithm::shortDescription() const +{ + return QObject::tr( "Calculates the minimum area rotated rectangle which covers each feature in an input layer." )" ); +} + QgsOrientedMinimumBoundingBoxAlgorithm *QgsOrientedMinimumBoundingBoxAlgorithm::createInstance() const { return new QgsOrientedMinimumBoundingBoxAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.h b/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.h index 920d47ee48b..76571f27a16 100644 --- a/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.h +++ b/src/analysis/processing/qgsalgorithmorientedminimumboundingbox.h @@ -38,6 +38,7 @@ class QgsOrientedMinimumBoundingBoxAlgorithm : public QgsProcessingFeatureBasedA QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsOrientedMinimumBoundingBoxAlgorithm *createInstance() const override SIP_FACTORY; bool supportInPlaceEdit( const QgsMapLayer *layer ) const override; diff --git a/src/analysis/processing/qgsalgorithmorthogonalize.cpp b/src/analysis/processing/qgsalgorithmorthogonalize.cpp index 8e1be3dfbf5..140affd2dad 100644 --- a/src/analysis/processing/qgsalgorithmorthogonalize.cpp +++ b/src/analysis/processing/qgsalgorithmorthogonalize.cpp @@ -62,6 +62,12 @@ QString QgsOrthogonalizeAlgorithm::shortHelpString() const "extra processing time." ); } +QString QgsOrthogonalizeAlgorithm::shortDescription() const +{ + return QObject::tr( "Takes a line or polygon layer and attempts to orthogonalize " + "all the geometries in the layer." ); +} + QString QgsOrthogonalizeAlgorithm::outputName() const { return QObject::tr( "Orthogonalized" ); diff --git a/src/analysis/processing/qgsalgorithmorthogonalize.h b/src/analysis/processing/qgsalgorithmorthogonalize.h index 100a58682f0..21bb423687d 100644 --- a/src/analysis/processing/qgsalgorithmorthogonalize.h +++ b/src/analysis/processing/qgsalgorithmorthogonalize.h @@ -38,6 +38,7 @@ class QgsOrthogonalizeAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QList inputLayerTypes() const override; QgsOrthogonalizeAlgorithm *createInstance() const override SIP_FACTORY; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmpackage.cpp b/src/analysis/processing/qgsalgorithmpackage.cpp index 67307298799..20840e07c02 100644 --- a/src/analysis/processing/qgsalgorithmpackage.cpp +++ b/src/analysis/processing/qgsalgorithmpackage.cpp @@ -69,6 +69,11 @@ QString QgsPackageAlgorithm::shortHelpString() const return QObject::tr( "This algorithm collects a number of existing layers and packages them together into a single GeoPackage database." ); } +QString QgsPackageAlgorithm::shortDescription() const +{ + return QObject::tr( "Packages a number of existing layers together into a single GeoPackage database." ); +} + QgsPackageAlgorithm *QgsPackageAlgorithm::createInstance() const { return new QgsPackageAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmpackage.h b/src/analysis/processing/qgsalgorithmpackage.h index da67c643339..067b563bc50 100644 --- a/src/analysis/processing/qgsalgorithmpackage.h +++ b/src/analysis/processing/qgsalgorithmpackage.h @@ -41,6 +41,7 @@ class QgsPackageAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsPackageAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.cpp b/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.cpp index db9957db890..b8b0954fa04 100644 --- a/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.cpp +++ b/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.cpp @@ -48,10 +48,15 @@ QString QgsPixelCentroidsFromPolygonsAlgorithm::groupId() const QString QgsPixelCentroidsFromPolygonsAlgorithm::shortHelpString() const { - return QObject::tr( "Generates pixel centroids for the raster area falling inside polygons. Used to generate points " + return QObject::tr( "This algorithm generates pixel centroids for the raster area falling inside polygons. Used to generate points " "for further raster sampling." ); } +QString QgsPixelCentroidsFromPolygonsAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates pixel centroids for the raster area falling inside polygons." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsPixelCentroidsFromPolygonsAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.h b/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.h index 6797a0ed804..c9645f4b1a4 100644 --- a/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.h +++ b/src/analysis/processing/qgsalgorithmpixelcentroidsfrompolygons.h @@ -38,6 +38,7 @@ class QgsPixelCentroidsFromPolygonsAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override; QgsPixelCentroidsFromPolygonsAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmpointonsurface.cpp b/src/analysis/processing/qgsalgorithmpointonsurface.cpp index 9f771350d60..662afc6ec42 100644 --- a/src/analysis/processing/qgsalgorithmpointonsurface.cpp +++ b/src/analysis/processing/qgsalgorithmpointonsurface.cpp @@ -59,6 +59,11 @@ QgsFeatureSink::SinkFlags QgsPointOnSurfaceAlgorithm::sinkFlags() const } QString QgsPointOnSurfaceAlgorithm::shortHelpString() const +{ + return QObject::tr( "This algorithm returns a point guaranteed to lie on the surface of a geometry." ); +} + +QString QgsPointOnSurfaceAlgorithm::shortDescription() const { return QObject::tr( "Returns a point guaranteed to lie on the surface of a geometry." ); } diff --git a/src/analysis/processing/qgsalgorithmpointonsurface.h b/src/analysis/processing/qgsalgorithmpointonsurface.h index 93ccfce8576..0656a97198b 100644 --- a/src/analysis/processing/qgsalgorithmpointonsurface.h +++ b/src/analysis/processing/qgsalgorithmpointonsurface.h @@ -41,6 +41,7 @@ class QgsPointOnSurfaceAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsPointOnSurfaceAlgorithm *createInstance() const override SIP_FACTORY; void initParameters( const QVariantMap &configuration = QVariantMap() ) override; diff --git a/src/analysis/processing/qgsalgorithmpointslayerfromtable.cpp b/src/analysis/processing/qgsalgorithmpointslayerfromtable.cpp index 774de230a96..b0491fb71fe 100644 --- a/src/analysis/processing/qgsalgorithmpointslayerfromtable.cpp +++ b/src/analysis/processing/qgsalgorithmpointslayerfromtable.cpp @@ -56,6 +56,11 @@ QString QgsPointsLayerFromTableAlgorithm::shortHelpString() const "the resulting layer will be the input table." ); } +QString QgsPointsLayerFromTableAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a points layer based on the values from an input table." ); +} + Qgis::ProcessingAlgorithmDocumentationFlags QgsPointsLayerFromTableAlgorithm::documentationFlags() const { return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey; diff --git a/src/analysis/processing/qgsalgorithmpointslayerfromtable.h b/src/analysis/processing/qgsalgorithmpointslayerfromtable.h index 910210231e2..4437786910d 100644 --- a/src/analysis/processing/qgsalgorithmpointslayerfromtable.h +++ b/src/analysis/processing/qgsalgorithmpointslayerfromtable.h @@ -40,6 +40,7 @@ class QgsPointsLayerFromTableAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override; QgsPointsLayerFromTableAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmpointstopaths.cpp b/src/analysis/processing/qgsalgorithmpointstopaths.cpp index 4d11f2f196d..3d1c94d300e 100644 --- a/src/analysis/processing/qgsalgorithmpointstopaths.cpp +++ b/src/analysis/processing/qgsalgorithmpointstopaths.cpp @@ -45,6 +45,11 @@ QString QgsPointsToPathsAlgorithm::shortHelpString() const "An attribute or expression can be selected to group points having the same value into the same resulting line." ); } +QString QgsPointsToPathsAlgorithm::shortDescription() const +{ + return QObject::tr( "Takes a point layer and connects its features creating a new line layer." ); +} + QStringList QgsPointsToPathsAlgorithm::tags() const { return QObject::tr( "create,lines,points,connect,convert,join,path" ).split( ',' ); diff --git a/src/analysis/processing/qgsalgorithmpointstopaths.h b/src/analysis/processing/qgsalgorithmpointstopaths.h index c99b8a33d9c..c04ae0dbce2 100644 --- a/src/analysis/processing/qgsalgorithmpointstopaths.h +++ b/src/analysis/processing/qgsalgorithmpointstopaths.h @@ -39,6 +39,7 @@ class QgsPointsToPathsAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsPointsToPathsAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmpointtolayer.cpp b/src/analysis/processing/qgsalgorithmpointtolayer.cpp index abe5bb616d7..ccff6cffeca 100644 --- a/src/analysis/processing/qgsalgorithmpointtolayer.cpp +++ b/src/analysis/processing/qgsalgorithmpointtolayer.cpp @@ -37,6 +37,11 @@ QString QgsPointToLayerAlgorithm::shortHelpString() const "a layer based input." ); } +QString QgsPointToLayerAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a vector layer that contains a single feature with geometry matching a point parameter." ); +} + QgsPointToLayerAlgorithm *QgsPointToLayerAlgorithm::createInstance() const { return new QgsPointToLayerAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmpointtolayer.h b/src/analysis/processing/qgsalgorithmpointtolayer.h index e245de3b365..2865d4f6ee3 100644 --- a/src/analysis/processing/qgsalgorithmpointtolayer.h +++ b/src/analysis/processing/qgsalgorithmpointtolayer.h @@ -39,6 +39,7 @@ class QgsPointToLayerAlgorithm : public QgsProcessingAlgorithm QString group() const override { return QObject::tr( "Vector geometry" ); } QString groupId() const override { return QStringLiteral( "vectorgeometry" ); } QString shortHelpString() const override; + QString shortDescription() const override; QgsPointToLayerAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmpoleofinaccessibility.cpp b/src/analysis/processing/qgsalgorithmpoleofinaccessibility.cpp index 4a82b89e3c8..a764664964d 100644 --- a/src/analysis/processing/qgsalgorithmpoleofinaccessibility.cpp +++ b/src/analysis/processing/qgsalgorithmpoleofinaccessibility.cpp @@ -57,6 +57,12 @@ QString QgsPoleOfInaccessibilityAlgorithm::shortHelpString() const "attribute in the output layer." ); } +QString QgsPoleOfInaccessibilityAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a point layer with features representing the most " + "distant internal point from the boundary of the surface for a polygon layer." ); +} + QString QgsPoleOfInaccessibilityAlgorithm::svgIconPath() const { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmCentroids.svg" ) ); diff --git a/src/analysis/processing/qgsalgorithmpoleofinaccessibility.h b/src/analysis/processing/qgsalgorithmpoleofinaccessibility.h index 395394f4c87..36722ec5dea 100644 --- a/src/analysis/processing/qgsalgorithmpoleofinaccessibility.h +++ b/src/analysis/processing/qgsalgorithmpoleofinaccessibility.h @@ -38,6 +38,7 @@ class QgsPoleOfInaccessibilityAlgorithm : public QgsProcessingFeatureBasedAlgori QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QString svgIconPath() const override; QIcon icon() const override; QList inputLayerTypes() const override; diff --git a/src/analysis/processing/qgsalgorithmpolygonize.cpp b/src/analysis/processing/qgsalgorithmpolygonize.cpp index d6e74969ac9..9fcbea9e265 100644 --- a/src/analysis/processing/qgsalgorithmpolygonize.cpp +++ b/src/analysis/processing/qgsalgorithmpolygonize.cpp @@ -31,6 +31,11 @@ QString QgsPolygonizeAlgorithm::displayName() const } QString QgsPolygonizeAlgorithm::shortHelpString() const +{ + return QObject::tr( "This algorithm creates a polygon layer from the input lines layer." ); +} + +QString QgsPolygonizeAlgorithm::shortDescription() const { return QObject::tr( "Creates a polygon layer from the input lines layer." ); } diff --git a/src/analysis/processing/qgsalgorithmpolygonize.h b/src/analysis/processing/qgsalgorithmpolygonize.h index c2879f406fa..5295383a6cb 100644 --- a/src/analysis/processing/qgsalgorithmpolygonize.h +++ b/src/analysis/processing/qgsalgorithmpolygonize.h @@ -39,6 +39,7 @@ class QgsPolygonizeAlgorithm : public QgsProcessingAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsPolygonizeAlgorithm *createInstance() const override SIP_FACTORY; protected: diff --git a/src/analysis/processing/qgsalgorithmpolygonstolines.cpp b/src/analysis/processing/qgsalgorithmpolygonstolines.cpp index 3524bd06941..014d4ab952f 100644 --- a/src/analysis/processing/qgsalgorithmpolygonstolines.cpp +++ b/src/analysis/processing/qgsalgorithmpolygonstolines.cpp @@ -77,7 +77,7 @@ Qgis::WkbType QgsPolygonsToLinesAlgorithm::outputWkbType( Qgis::WkbType inputWkb QString QgsPolygonsToLinesAlgorithm::shortHelpString() const { - return QObject::tr( "Converts polygons to lines" ); + return QObject::tr( "This algorithm converts polygons to lines." ); } QString QgsPolygonsToLinesAlgorithm::shortDescription() const diff --git a/src/analysis/processing/qgsalgorithmprojectpointcartesian.cpp b/src/analysis/processing/qgsalgorithmprojectpointcartesian.cpp index 63f2234c879..2ddec162c23 100644 --- a/src/analysis/processing/qgsalgorithmprojectpointcartesian.cpp +++ b/src/analysis/processing/qgsalgorithmprojectpointcartesian.cpp @@ -56,6 +56,11 @@ QString QgsProjectPointCartesianAlgorithm::shortHelpString() const "The distance is specified in layer units, and the bearing in degrees clockwise from North." ); } +QString QgsProjectPointCartesianAlgorithm::shortDescription() const +{ + return QObject::tr( "Creates a point layer with geometries projected by a specified distance and bearing (azimuth)." ); +} + QList QgsProjectPointCartesianAlgorithm::inputLayerTypes() const { return QList() << static_cast( Qgis::ProcessingSourceType::VectorPoint ); diff --git a/src/analysis/processing/qgsalgorithmprojectpointcartesian.h b/src/analysis/processing/qgsalgorithmprojectpointcartesian.h index dc649a3262c..483d5e68424 100644 --- a/src/analysis/processing/qgsalgorithmprojectpointcartesian.h +++ b/src/analysis/processing/qgsalgorithmprojectpointcartesian.h @@ -38,6 +38,7 @@ class QgsProjectPointCartesianAlgorithm : public QgsProcessingFeatureBasedAlgori QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QList inputLayerTypes() const override; Qgis::ProcessingSourceType outputLayerType() const override; QgsProjectPointCartesianAlgorithm *createInstance() const override SIP_FACTORY; diff --git a/src/analysis/processing/qgsalgorithmpromotetomultipart.cpp b/src/analysis/processing/qgsalgorithmpromotetomultipart.cpp index c238b3d5e22..cf531901fe3 100644 --- a/src/analysis/processing/qgsalgorithmpromotetomultipart.cpp +++ b/src/analysis/processing/qgsalgorithmpromotetomultipart.cpp @@ -59,6 +59,11 @@ QString QgsPromoteToMultipartAlgorithm::shortHelpString() const + QStringLiteral( "\n\n" ) + QObject::tr( "See the 'Collect geometries' or 'Aggregate' algorithms for alternative options." ); } +QString QgsPromoteToMultipartAlgorithm::shortDescription() const +{ + return QObject::tr( "Generates a vector layer in which all geometries are multipart." ); +} + QgsPromoteToMultipartAlgorithm *QgsPromoteToMultipartAlgorithm::createInstance() const { return new QgsPromoteToMultipartAlgorithm(); diff --git a/src/analysis/processing/qgsalgorithmpromotetomultipart.h b/src/analysis/processing/qgsalgorithmpromotetomultipart.h index 3d8c2b24e82..276a308911c 100644 --- a/src/analysis/processing/qgsalgorithmpromotetomultipart.h +++ b/src/analysis/processing/qgsalgorithmpromotetomultipart.h @@ -42,6 +42,7 @@ class QgsPromoteToMultipartAlgorithm : public QgsProcessingFeatureBasedAlgorithm QString group() const override; QString groupId() const override; QString shortHelpString() const override; + QString shortDescription() const override; QgsPromoteToMultipartAlgorithm *createInstance() const override SIP_FACTORY; bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;