API doc and typo fixes

qgis · Apr 9, 2018 · 2378a37 · 2378a37
1 parent 0b149f5
commit 2378a37
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/python/gui/processing/qgsprocessingalgorithmconfigurationwidget.sip.in b/python/gui/processing/qgsprocessingalgorithmconfigurationwidget.sip.in
@@ -1,7 +1,7 @@
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/core/processing/qgsprocessingalgorithmconfigurationwidget.h      *
+ * src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h       *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
  ************************************************************************/
@@ -12,11 +12,10 @@
 
 
 
-
 class QgsProcessingAlgorithmConfigurationWidget : QWidget
 {
 %Docstring
-A configuration widget for processing algorithms allows to provide additional
+A configuration widget for processing algorithms allows providing additional
 configuration options directly on algorithm level, in addition to parameters.
 
 .. versionadded:: 3.2
@@ -74,7 +73,7 @@ Check if this factory can create widgets for ``algorithm``.
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/core/processing/qgsprocessingalgorithmconfigurationwidget.h      *
+ * src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h       *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
  ************************************************************************/
diff --git a/python/gui/processing/qgsprocessingguiregistry.sip.in b/python/gui/processing/qgsprocessingguiregistry.sip.in
@@ -24,7 +24,12 @@ configuration widgets.
 #include "qgsprocessingguiregistry.h"
 %End
   public:
+
     QgsProcessingGuiRegistry();
+%Docstring
+Constructor. Should never be called manually, is already
+created by :py:class:`QgsGui`.
+%End
     ~QgsProcessingGuiRegistry();
 
     void addAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory /Transfer/ );

diff --git a/src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h b/src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h
@@ -29,7 +29,7 @@ class QgsProcessingAlgorithm;
 class QgsProcessingAlgorithmConfigurationWidget;
 
 /**
- * A configuration widget for processing algorithms allows to provide additional
+ * A configuration widget for processing algorithms allows providing additional
  * configuration options directly on algorithm level, in addition to parameters.
  *
  * \since QGIS 3.2

diff --git a/src/gui/processing/qgsprocessingguiregistry.h b/src/gui/processing/qgsprocessingguiregistry.h
@@ -37,6 +37,11 @@ class QgsProcessingAlgorithmConfigurationWidgetFactory;
 class GUI_EXPORT QgsProcessingGuiRegistry
 {
   public:
+
+    /**
+     * Constructor. Should never be called manually, is already
+     * created by QgsGui.
+     */
     QgsProcessingGuiRegistry();
     ~QgsProcessingGuiRegistry();