Skip to content

Commit 02da420

Browse files
committed
Add a remaining docstring
1 parent 41b47a2 commit 02da420

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

python/gui/processing/qgsprocessingguiregistry.sip.in

+5-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,11 @@ widgets.
5050

5151
QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;
5252
%Docstring
53-
algorithmConfigurationWidget
54-
@param algorithm
55-
@return
53+
Get the configuration widget for an ``algorithm``. This widget will be shown
54+
next to parameter widgets. Most algorithms do not have a configuration widget
55+
and in this case, None will be returned.
56+
57+
.. versionadded:: 3.2
5658
%End
5759

5860
};

src/gui/processing/qgsprocessingguiregistry.h

+5-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,11 @@ class GUI_EXPORT QgsProcessingGuiRegistry
6262
void removeAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory );
6363

6464
/**
65-
* @brief algorithmConfigurationWidget
66-
* @param algorithm
67-
* @return
65+
* Get the configuration widget for an \a algorithm. This widget will be shown
66+
* next to parameter widgets. Most algorithms do not have a configuration widget
67+
* and in this case, nullptr will be returned.
68+
*
69+
* \since QGIS 3.2
6870
*/
6971
QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;
7072

0 commit comments

Comments
 (0)