Skip to content
Permalink
Browse files

Code and doc improvements

  • Loading branch information
m-kuhn authored and nyalldawson committed Mar 6, 2018
1 parent b5672d7 commit 569b39b2574845eca9a5f065d73db3d6191b9c80
@@ -107,10 +107,11 @@ according to some user configuration.
.. seealso:: :py:func:`algorithmById`
%End

void addParameterType( QgsProcessingParameterType *type );
void addParameterType( QgsProcessingParameterType *type /Transfer/ );
%Docstring
Register a new parameter type for processing.
Will emit parameterTypeAdded
Ownership is transferred to the registry.
Will emit parameterTypeAdded.

.. seealso:: :py:func:`removeParameterType`

@@ -120,7 +121,8 @@ Will emit parameterTypeAdded
void removeParameterType( QgsProcessingParameterType *type );
%Docstring
Unregister a custom parameter type from processing.
Will emit parameterTypeRemoved
The type will be deleted.
Will emit parameterTypeRemoved.

.. seealso:: :py:func:`addParameterType`

@@ -134,17 +134,19 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject

/**
* Register a new parameter type for processing.
* Will emit parameterTypeAdded
* Ownership is transferred to the registry.
* Will emit parameterTypeAdded.
*
* \see removeParameterType
*
* \since QGIS 3.2
*/
void addParameterType( QgsProcessingParameterType *type );
void addParameterType( QgsProcessingParameterType *type SIP_TRANSFER );

/**
* Unregister a custom parameter type from processing.
* Will emit parameterTypeRemoved
* The type will be deleted.
* Will emit parameterTypeRemoved.
*
* \see addParameterType
*
@@ -196,7 +198,7 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
QMap<QString, QgsProcessingProvider *> mProviders;

//! Hash of available parameter types by id. This object owns the pointers.
QHash<QString, QgsProcessingParameterType *> mParameterTypes;
QMap<QString, QgsProcessingParameterType *> mParameterTypes;

#ifdef SIP_RUN
QgsProcessingRegistry( const QgsProcessingRegistry &other );

0 comments on commit 569b39b

Please sign in to comment.
You can’t perform that action at this time.