Navigation Menu

Skip to content


Deprecate unused QgsProcessingAlgorithm::helpString method
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Sep 25, 2018
1 parent 844a3fb commit d26f25c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
Expand Up @@ -140,14 +140,16 @@ about what the algorithm does and the parameters and outputs associated with it.
.. seealso:: :py:func:`helpUrl`

virtual QString helpString() const;
virtual QString helpString() const /Deprecated/;
Returns a localised help string for the algorithm. Algorithm subclasses should implement either
helpString() or helpUrl().

.. seealso:: :py:func:`helpUrl`

.. seealso:: :py:func:`shortHelpString`

.. deprecated:: Unused, will be removed in QGIS 4.0

virtual QString helpUrl() const;
Expand Down
3 changes: 2 additions & 1 deletion src/core/processing/qgsprocessingalgorithm.h
Expand Up @@ -183,8 +183,9 @@ class CORE_EXPORT QgsProcessingAlgorithm
* helpString() or helpUrl().
* \see helpUrl()
* \see shortHelpString()
* \deprecated Unused, will be removed in QGIS 4.0
virtual QString helpString() const;
Q_DECL_DEPRECATED virtual QString helpString() const SIP_DEPRECATED;

* Returns a url pointing to the algorithm's help page.
Expand Down

0 comments on commit d26f25c

Please sign in to comment.