Skip to content

Commit d26f25c

Browse files
committed
Deprecate unused QgsProcessingAlgorithm::helpString method
1 parent 844a3fb commit d26f25c

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,14 +140,16 @@ about what the algorithm does and the parameters and outputs associated with it.
140140
.. seealso:: :py:func:`helpUrl`
141141
%End
142142

143-
virtual QString helpString() const;
143+
virtual QString helpString() const /Deprecated/;
144144
%Docstring
145145
Returns a localised help string for the algorithm. Algorithm subclasses should implement either
146146
helpString() or helpUrl().
147147

148148
.. seealso:: :py:func:`helpUrl`
149149

150150
.. seealso:: :py:func:`shortHelpString`
151+
152+
.. deprecated:: Unused, will be removed in QGIS 4.0
151153
%End
152154

153155
virtual QString helpUrl() const;

src/core/processing/qgsprocessingalgorithm.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,9 @@ class CORE_EXPORT QgsProcessingAlgorithm
183183
* helpString() or helpUrl().
184184
* \see helpUrl()
185185
* \see shortHelpString()
186+
* \deprecated Unused, will be removed in QGIS 4.0
186187
*/
187-
virtual QString helpString() const;
188+
Q_DECL_DEPRECATED virtual QString helpString() const SIP_DEPRECATED;
188189

189190
/**
190191
* Returns a url pointing to the algorithm's help page.

0 commit comments

Comments
 (0)