fix documentation

This commit is contained in:
Denis Rouzaud 2019-12-05 10:17:51 +01:00
parent 2868074eb3
commit dbd2d74a57
3 changed files with 9 additions and 9 deletions

View File

@ -292,21 +292,21 @@ Returns the label for a range
const QgsProcessingParameterDefinition *parameterDefinition( const QString &parameterName ) const;
%Docstring
Get parameter from its id
Returns the parameter from its name
.. versionadded:: 3.12
%End
QgsProcessingParameterDefinitions parameterDefinitions() const;
%Docstring
List of parameters
Returns the list of parameters
.. versionadded:: 3.12
%End
void setParameterValues( const QVariantMap &values );
%Docstring
Set values of the additional parameters
Defines the values of the additional parameters
.. versionadded:: 3.12
%End
@ -343,7 +343,7 @@ The paramaeter is a processing parameter which will allow its configuration in t
QVariantMap parameterValues() const;
%Docstring
Return the values of the processing parameters.
Returns the values of the processing parameters.
One could use QgsProcessingParameters.parameterAsXxxx to retrieve the actual value of a parameter.
%End

View File

@ -272,19 +272,19 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
QString labelForRange( const QgsRendererRange &range, ClassPosition position = Inner ) const;
/**
* Get parameter from its id
* Returns the parameter from its name
* \since QGIS 3.12
*/
const QgsProcessingParameterDefinition *parameterDefinition( const QString &parameterName ) const;
/**
* List of parameters
* Returns the list of parameters
* \since QGIS 3.12
*/
QgsProcessingParameterDefinitions parameterDefinitions() const {return mParameters;}
/**
* Set values of the additional parameters
* Defines the values of the additional parameters
* \since QGIS 3.12
*/
void setParameterValues( const QVariantMap &values );
@ -312,7 +312,7 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
void addParameter( QgsProcessingParameterDefinition *definition SIP_TRANSFER );
/**
* Return the values of the processing parameters.
* Returns the values of the processing parameters.
* One could use QgsProcessingParameters::parameterAsXxxx to retrieve the actual value of a parameter.
*/
QVariantMap parameterValues() const {return mParameterValues;}

View File

@ -839,7 +839,7 @@ void QgsGraduatedSymbolRendererWidget::updateMethodParameters()
connect( ppww, &QgsAbstractProcessingParameterWidgetWrapper::widgetValueHasChanged, this, &QgsGraduatedSymbolRendererWidget::classifyGraduated );
mParameterWidgetWrappers.push_back( std::unique_ptr<QgsAbstractProcessingParameterWidgetWrapper>(ppww) );
mParameterWidgetWrappers.push_back( std::unique_ptr<QgsAbstractProcessingParameterWidgetWrapper>( ppww ) );
}
}