Skip to content
Permalink
Browse files

Dox++

  • Loading branch information
nyalldawson committed Sep 21, 2020
1 parent 6076950 commit ed6e9ac84c63c0e999420afa050c7890017ef361
@@ -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
@@ -482,13 +482,21 @@ 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
*/
QString help() const { return mHelp; }

/**
* 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
*/

0 comments on commit ed6e9ac

Please sign in to comment.
You can’t perform that action at this time.