Skip to content

Commit

Permalink
Fix doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
@nyalldawson
nyalldawson committed Apr 3, 2018
1 parent 3eeb1b5 commit e1db9d4
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 34 deletions.
18 changes: 9 additions & 9 deletions python/core/raster/qgsrastershader.sip.in
View file
Expand Up @@ -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
Expand All @@ -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
Expand Down
16 changes: 8 additions & 8 deletions python/core/raster/qgsrastershaderfunction.sip.in
View file
Expand Up @@ -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
Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/core/expression/qgsexpressionfunction.cpp
View file
Expand Up @@ -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,
Expand All @@ -147,6 +149,7 @@ QgsStaticExpressionFunction::QgsStaticExpressionFunction( const QString &fnname,
, mReferencedColumnsFunc( referencedColumns )
{
}
///@endcond

QStringList QgsStaticExpressionFunction::aliases() const
{
Expand Down
18 changes: 9 additions & 9 deletions src/core/raster/qgsrastershader.h
View file
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
16 changes: 8 additions & 8 deletions src/core/raster/qgsrastershaderfunction.h
View file
Expand Up @@ -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,
Expand All @@ -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,
Expand Down

0 comments on commit e1db9d4

Please sign in to comment.