Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Typo
  • Loading branch information
nyalldawson committed May 26, 2018
1 parent ff55cfc commit fa5a7d2
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
Expand Up @@ -26,14 +26,14 @@ a specified bounding range.
QgsContrastEnhancementFunction( const QgsContrastEnhancementFunction &f );
virtual ~QgsContrastEnhancementFunction();

virtual int enhance( double );
virtual int enhance( double value );
%Docstring
A customizable method that takes in a double and returns a int between 0 and 255
A customizable method that takes in a double ``value`` and returns a int between 0 and 255.
%End

virtual bool isValueInDisplayableRange( double );
virtual bool isValueInDisplayableRange( double value );
%Docstring
A customicable method to indicate if the pixels is displayable
A customizable method to indicate if a pixel's value is within the displayable range.
%End

void setMaximumValue( double value );
Expand Down
1 change: 1 addition & 0 deletions scripts/spell_check/spelling.dat
Expand Up @@ -1887,6 +1887,7 @@ curently:currently
currenly:currently
currnt:current
curriculem:curriculum
customicable:customizable
cxan:cyan
cyclinder:cylinder
cymk:CMYK
Expand Down
12 changes: 8 additions & 4 deletions src/core/raster/qgscontrastenhancementfunction.h
Expand Up @@ -37,11 +37,15 @@ class CORE_EXPORT QgsContrastEnhancementFunction
QgsContrastEnhancementFunction( const QgsContrastEnhancementFunction &f );
virtual ~QgsContrastEnhancementFunction() = default;

//! \brief A customizable method that takes in a double and returns a int between 0 and 255
virtual int enhance( double );
/**
* A customizable method that takes in a double \a value and returns a int between 0 and 255.
*/
virtual int enhance( double value );

//! \brief A customicable method to indicate if the pixels is displayable
virtual bool isValueInDisplayableRange( double );
/**
* A customizable method to indicate if a pixel's value is within the displayable range.
*/
virtual bool isValueInDisplayableRange( double value );

/**
* Sets the maximum \a value.
Expand Down

0 comments on commit fa5a7d2

Please sign in to comment.