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

Dox++

Browse Source
This commit is contained in:
Nyall Dawson 2020-09-21 08:11:31 +10:00
parent 6076950c68
commit ed6e9ac84c
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -379,6 +379,9 @@ used to identify this parameter.
%Docstring
Returns the help for the parameter.
This is a descriptive (possibly lengthy), translated string explaining
the parameter's behavior and use in depth.
.. seealso:: :py:func:`setHelp`
.. versionadded:: 3.16
@ -388,6 +391,9 @@ Returns the help for the parameter.
%Docstring
Sets the ``help`` for the parameter.
The ``help`` string should be a descriptive, translated string explaining
the parameter's behavior and use in depth.
.. seealso:: :py:func:`help`
.. versionadded:: 3.16

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

@ -482,6 +482,10 @@ class CORE_EXPORT QgsProcessingParameterDefinition
/**
* Returns the help for the parameter.
*
* This is a descriptive (possibly lengthy), translated string explaining
* the parameter's behavior and use in depth.
*
* \see setHelp()
* \since QGIS 3.16
*/
@ -489,6 +493,10 @@ class CORE_EXPORT QgsProcessingParameterDefinition
/**
* Sets the \a help for the parameter.
*
* The \a help string should be a descriptive, translated string explaining
* the parameter's behavior and use in depth.
*
* \see help()
* \since QGIS 3.16
*/