Skip to content

Commit e1db9d4

Browse files
nyalldawsonnyalldawson
committedApr 3, 2018
Fix doxygen warnings
·
ltr-3_40final-3_2_0
1 parent 3eeb1b5 commit e1db9d4

File tree

5 files changed

+37
-34
lines changed

5 files changed

+37
-34
lines changed
 

‎python/core/raster/qgsrastershader.sip.in

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Returns the minimum value for the raster shader.
5555
Generates a new RGBA value based on one input ``value``.
5656

5757
:param value: The original value to base a new RGBA value on
58-
:param returnRedValue: The red component of the new RGBA value
59-
:param returnGreenValue: The green component of the new RGBA value
60-
:param returnBlueValue: The blue component of the new RGBA value
61-
:param returnAlpha: The alpha component of the new RGBA value
58+
:param returnRedValue: The red component of the new RGBA value
59+
:param returnGreenValue: The green component of the new RGBA value
60+
:param returnBlueValue: The blue component of the new RGBA value
61+
:param returnAlpha: The alpha component of the new RGBA value
6262

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

8686
:return: True if the return values are valid otherwise false
8787
%End

‎python/core/raster/qgsrastershaderfunction.sip.in

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ Sets the minimum ``value`` for the raster shader.
5959
Generates an new RGBA value based on one input ``value``.
6060

6161
:param value: The original value to base a new RGBA value on
62-
:param returnRedValue: The red component of the new RGBA value
63-
:param returnGreenValue: The green component of the new RGBA value
64-
:param returnBlueValue: The blue component of the new RGBA value
65-
:param returnAlphaValue: The blue component of the new RGBA value
62+
:param returnRedValue: The red component of the new RGBA value
63+
:param returnGreenValue: The green component of the new RGBA value
64+
:param returnBlueValue: The blue component of the new RGBA value
65+
:param returnAlpha: The blue component of the new RGBA value
6666

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

9090
:return: True if the return values are valid otherwise false
9191
%End

‎src/core/expression/qgsexpressionfunction.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ bool QgsExpressionFunction::handlesNull() const
130130
return mHandlesNull;
131131
}
132132

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

151154
QStringList QgsStaticExpressionFunction::aliases() const
152155
{

‎src/core/raster/qgsrastershader.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ class CORE_EXPORT QgsRasterShader
7575
* Generates a new RGBA value based on one input \a value.
7676
*
7777
* \param value The original value to base a new RGBA value on
78-
* \param returnRedValue The red component of the new RGBA value
79-
* \param returnGreenValue The green component of the new RGBA value
80-
* \param returnBlueValue The blue component of the new RGBA value
81-
* \param returnAlpha The alpha component of the new RGBA value
78+
* \param returnRedValue The red component of the new RGBA value
79+
* \param returnGreenValue The green component of the new RGBA value
80+
* \param returnBlueValue The blue component of the new RGBA value
81+
* \param returnAlpha The alpha component of the new RGBA value
8282
* \return True if the return values are valid otherwise false
8383
*/
8484
bool shade( double value,
@@ -92,11 +92,11 @@ class CORE_EXPORT QgsRasterShader
9292
* \param redValue The red component of the original value to base a new RGBA value on
9393
* \param greenValue The green component of the original value to base a new RGBA value on
9494
* \param blueValue The blue component of the original value to base a new RGBA value on
95-
* \param alphaValue The alpha component of the original value to base a new RGBA value on
96-
* \param returnRedValue The red component of the new RGBA value
97-
* \param returnGreenValue The green component of the new RGBA value
98-
* \param returnBlueValue The blue component of the new RGBA value
99-
* \param returnAlphaValue The alpha component of the new RGBA value
95+
* \param alphaValue The alpha component of the original value to base a new RGBA value on
96+
* \param returnRedValue The red component of the new RGBA value
97+
* \param returnGreenValue The green component of the new RGBA value
98+
* \param returnBlueValue The blue component of the new RGBA value
99+
* \param returnAlpha The alpha component of the new RGBA value
100100
* \return True if the return values are valid otherwise false
101101
*/
102102
bool shade( double redValue,

‎src/core/raster/qgsrastershaderfunction.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ class CORE_EXPORT QgsRasterShaderFunction
6868
/**
6969
* Generates an new RGBA value based on one input \a value.
7070
* \param value The original value to base a new RGBA value on
71-
* \param returnRedValue The red component of the new RGBA value
72-
* \param returnGreenValue The green component of the new RGBA value
73-
* \param returnBlueValue The blue component of the new RGBA value
74-
* \param returnAlphaValue The blue component of the new RGBA value
71+
* \param returnRedValue The red component of the new RGBA value
72+
* \param returnGreenValue The green component of the new RGBA value
73+
* \param returnBlueValue The blue component of the new RGBA value
74+
* \param returnAlpha The blue component of the new RGBA value
7575
* \return True if the return values are valid otherwise false
7676
*/
7777
virtual bool shade( double value,
@@ -87,10 +87,10 @@ class CORE_EXPORT QgsRasterShaderFunction
8787
* \param greenValue The green component of the original value to base a new RGBA value on
8888
* \param blueValue The blue component of the original value to base a new RGBA value on
8989
* \param alphaValue The alpha component of the original value to base a new RGBA value on
90-
* \param returnRedValue The red component of the new RGBA value
91-
* \param returnGreenValue The green component of the new RGBA value
92-
* \param returnBlueValue The blue component of the new RGBA value
93-
* \param returnAlphaValue The alpha component of the new RGBA value
90+
* \param returnRedValue The red component of the new RGBA value
91+
* \param returnGreenValue The green component of the new RGBA value
92+
* \param returnBlueValue The blue component of the new RGBA value
93+
* \param returnAlpha The alpha component of the new RGBA value
9494
* \return True if the return values are valid otherwise false
9595
*/
9696
virtual bool shade( double redValue,

0 commit comments

Comments
 (0)
Please sign in to comment.