API doc and typo fixes

This commit is contained in:
Matthias Kuhn 2018-04-08 21:48:29 +02:00
parent 0b149f5282
commit 2378a37dc1
4 changed files with 14 additions and 5 deletions

View File

@ -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 *
************************************************************************/

View File

@ -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/ );

View File

@ -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

View File

@ -37,6 +37,11 @@ class QgsProcessingAlgorithmConfigurationWidgetFactory;
class GUI_EXPORT QgsProcessingGuiRegistry
{
public:
/**
* Constructor. Should never be called manually, is already
* created by QgsGui.
*/
QgsProcessingGuiRegistry();
~QgsProcessingGuiRegistry();