sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-06 00:03:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

add \see and \since in comments

Browse Source
This commit is contained in:
Antoine 2021-09-22 11:18:29 +02:00 committed by Nyall Dawson
parent 38b504045e
commit 968db20b82
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
python/core/auto_generated/processing/qgsprocessingparameters.sip.in
View File

@ -387,6 +387,8 @@ Returns the description for the parameter. This is the user-visible string
used to identify this parameter. used to identify this parameter.
.. seealso:: :py:func:`setDescription` .. seealso:: :py:func:`setDescription`
.. seealso:: :py:func:`descriptionAsPythonString`
%End %End
void setDescription( const QString &description ); 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. The around quote could be single or double.
.. seealso:: :py:func:`description` .. seealso:: :py:func:`description`
.. versionadded:: 3.24
%End %End
virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const; virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;

3
src/core/processing/qgsprocessingparameters.h
View File

@ -496,6 +496,7 @@ class CORE_EXPORT QgsProcessingParameterDefinition
* Returns the description for the parameter. This is the user-visible string * Returns the description for the parameter. This is the user-visible string
* used to identify this parameter. * used to identify this parameter.
* \see setDescription() * \see setDescription()
* \see descriptionAsPythonString()
*/ */
QString description() const { return mDescription; } 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. * If there are quotes in the description, they are escaped if necessary.
* The around quote could be single or double. * The around quote could be single or double.
* \see description() * \see description()
*
* \since QGIS 3.24
*/ */
QString descriptionAsPythonString() const; QString descriptionAsPythonString() const;