add \see and \since in comments

qgis · Sep 24, 2021 · 968db20 · 968db20
1 parent 38b5040
commit 968db20
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git 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
@@ -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;