From 968db20b82f6929ea2f81cd2f85f9b1cf30609b3 Mon Sep 17 00:00:00 2001 From: Antoine Date: Wed, 22 Sep 2021 11:18:29 +0200 Subject: [PATCH] add \see and \since in comments --- .../auto_generated/processing/qgsprocessingparameters.sip.in | 4 ++++ src/core/processing/qgsprocessingparameters.h | 3 +++ 2 files changed, 7 insertions(+) diff --git a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in index 2684bcfd8a6..022f9d70695 100644 --- a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in @@ -387,6 +387,8 @@ Returns the description for the parameter. This is the user-visible string used to identify this parameter. .. seealso:: :py:func:`setDescription` + +.. seealso:: :py:func:`descriptionAsPythonString` %End void setDescription( const QString &description ); @@ -516,6 +518,8 @@ If there are quotes in the description, they are escaped if necessary. The around quote could be single or double. .. seealso:: :py:func:`description` + +.. versionadded:: 3.24 %End virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const; diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h index 358d11662f3..fe89ad88803 100644 --- a/src/core/processing/qgsprocessingparameters.h +++ b/src/core/processing/qgsprocessingparameters.h @@ -496,6 +496,7 @@ class CORE_EXPORT QgsProcessingParameterDefinition * Returns the description for the parameter. This is the user-visible string * used to identify this parameter. * \see setDescription() + * \see descriptionAsPythonString() */ QString description() const { return mDescription; } @@ -611,6 +612,8 @@ class CORE_EXPORT QgsProcessingParameterDefinition * If there are quotes in the description, they are escaped if necessary. * The around quote could be single or double. * \see description() + * + * \since QGIS 3.24 */ QString descriptionAsPythonString() const;