Skip to content
Permalink
Browse files

Fix doxygen warnings

  • Loading branch information
nyalldawson committed Apr 3, 2018
1 parent 3eeb1b5 commit e1db9d48989d7f3d0e640ced8d543a935a1d6cb0
@@ -55,10 +55,10 @@ Returns the minimum value for the raster shader.
Generates a new RGBA value based on one input ``value``.

:param value: The original value to base a new RGBA value on
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value

:return: True if the return values are valid otherwise false
%End
@@ -77,11 +77,11 @@ Generates a new RGBA value based on an original RGBA value.
:param redValue: The red component of the original value to base a new RGBA value on
:param greenValue: The green component of the original value to base a new RGBA value on
:param blueValue: The blue component of the original value to base a new RGBA value on
:param alphaValue: The alpha component of the original value to base a new RGBA value on
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlphaValue: The alpha component of the new RGBA value
:param alphaValue: The alpha component of the original value to base a new RGBA value on
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value

:return: True if the return values are valid otherwise false
%End
@@ -59,10 +59,10 @@ Sets the minimum ``value`` for the raster shader.
Generates an new RGBA value based on one input ``value``.

:param value: The original value to base a new RGBA value on
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlphaValue: The blue component of the new RGBA value
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The blue component of the new RGBA value

:return: True if the return values are valid otherwise false
%End
@@ -82,10 +82,10 @@ Generates an new RGBA value based on an original RGBA value.
:param greenValue: The green component of the original value to base a new RGBA value on
:param blueValue: The blue component of the original value to base a new RGBA value on
:param alphaValue: The alpha component of the original value to base a new RGBA value on
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlphaValue: The alpha component of the new RGBA value
:param returnRedValue: The red component of the new RGBA value
:param returnGreenValue: The green component of the new RGBA value
:param returnBlueValue: The blue component of the new RGBA value
:param returnAlpha: The alpha component of the new RGBA value

:return: True if the return values are valid otherwise false
%End
@@ -130,6 +130,8 @@ bool QgsExpressionFunction::handlesNull() const
return mHandlesNull;
}

// doxygen doesn't like this constructor for some reason (maybe the function arguments?)
///@ cond PRIVATE
QgsStaticExpressionFunction::QgsStaticExpressionFunction( const QString &fnname, const QgsExpressionFunction::ParameterList &params,
FcnEval fcn,
const QString &group,
@@ -147,6 +149,7 @@ QgsStaticExpressionFunction::QgsStaticExpressionFunction( const QString &fnname,
, mReferencedColumnsFunc( referencedColumns )
{
}
///@endcond

QStringList QgsStaticExpressionFunction::aliases() const
{
@@ -75,10 +75,10 @@ class CORE_EXPORT QgsRasterShader
* Generates a new RGBA value based on one input \a value.
*
* \param value The original value to base a new RGBA value on
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlpha The alpha component of the new RGBA value
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlpha The alpha component of the new RGBA value
* \return True if the return values are valid otherwise false
*/
bool shade( double value,
@@ -92,11 +92,11 @@ class CORE_EXPORT QgsRasterShader
* \param redValue The red component of the original value to base a new RGBA value on
* \param greenValue The green component of the original value to base a new RGBA value on
* \param blueValue The blue component of the original value to base a new RGBA value on
* \param alphaValue The alpha component of the original value to base a new RGBA value on
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlphaValue The alpha component of the new RGBA value
* \param alphaValue The alpha component of the original value to base a new RGBA value on
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlpha The alpha component of the new RGBA value
* \return True if the return values are valid otherwise false
*/
bool shade( double redValue,
@@ -68,10 +68,10 @@ class CORE_EXPORT QgsRasterShaderFunction
/**
* Generates an new RGBA value based on one input \a value.
* \param value The original value to base a new RGBA value on
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlphaValue The blue component of the new RGBA value
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlpha The blue component of the new RGBA value
* \return True if the return values are valid otherwise false
*/
virtual bool shade( double value,
@@ -87,10 +87,10 @@ class CORE_EXPORT QgsRasterShaderFunction
* \param greenValue The green component of the original value to base a new RGBA value on
* \param blueValue The blue component of the original value to base a new RGBA value on
* \param alphaValue The alpha component of the original value to base a new RGBA value on
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlphaValue The alpha component of the new RGBA value
* \param returnRedValue The red component of the new RGBA value
* \param returnGreenValue The green component of the new RGBA value
* \param returnBlueValue The blue component of the new RGBA value
* \param returnAlpha The alpha component of the new RGBA value
* \return True if the return values are valid otherwise false
*/
virtual bool shade( double redValue,

0 comments on commit e1db9d4

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