Add a remaining docstring

qgis · Apr 9, 2018 · 02da420 · 02da420
1 parent 41b47a2
commit 02da420
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/python/gui/processing/qgsprocessingguiregistry.sip.in b/python/gui/processing/qgsprocessingguiregistry.sip.in
@@ -50,9 +50,11 @@ widgets.
 
     QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;
 %Docstring
- algorithmConfigurationWidget
-@param algorithm
-@return
+Get the configuration widget for an ``algorithm``. This widget will be shown
+next to parameter widgets. Most algorithms do not have a configuration widget
+and in this case, None will be returned.
+
+.. versionadded:: 3.2
 %End
 
 };

diff --git a/src/gui/processing/qgsprocessingguiregistry.h b/src/gui/processing/qgsprocessingguiregistry.h
@@ -62,9 +62,11 @@ class GUI_EXPORT QgsProcessingGuiRegistry
     void removeAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory );
 
     /**
-     * @brief algorithmConfigurationWidget
-     * @param algorithm
-     * @return
+     * Get the configuration widget for an \a algorithm. This widget will be shown
+     * next to parameter widgets. Most algorithms do not have a configuration widget
+     * and in this case, nullptr will be returned.
+     *
+     * \since QGIS 3.2
      */
     QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;