Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Add 'mutator for ' to doxygen compliance blacklist
- Loading branch information
|
@@ -36,14 +36,18 @@ a specified bounding range. |
|
|
A customicable method to indicate if the pixels is displayable |
|
|
%End |
|
|
|
|
|
void setMaximumValue( double ); |
|
|
void setMaximumValue( double value ); |
|
|
%Docstring |
|
|
Mustator for the maximum value |
|
|
Sets the maximum ``value``. |
|
|
|
|
|
.. seealso:: :py:func:`setMinimumValue` |
|
|
%End |
|
|
|
|
|
void setMinimumValue( double ); |
|
|
void setMinimumValue( double value ); |
|
|
%Docstring |
|
|
Mutator for the minimum value |
|
|
Sets the minimum ``value``. |
|
|
|
|
|
.. seealso:: :py:func:`setMaximumValue` |
|
|
%End |
|
|
|
|
|
protected: |
|
|
|
@@ -60,14 +60,14 @@ Resets the transparency list to a single ``value``. |
|
|
Resets the transparency list to single red, green, and blue values. |
|
|
%End |
|
|
|
|
|
void setTransparentSingleValuePixelList( const QList<QgsRasterTransparency::TransparentSingleValuePixel> &newList /Transfer/ ); |
|
|
void setTransparentSingleValuePixelList( const QList<QgsRasterTransparency::TransparentSingleValuePixel> &newList ); |
|
|
%Docstring |
|
|
Mutator for transparentSingleValuePixelList, replaces the whole list |
|
|
Sets the transparent single value pixel list, replacing the whole existing list. |
|
|
%End |
|
|
|
|
|
void setTransparentThreeValuePixelList( const QList<QgsRasterTransparency::TransparentThreeValuePixel> &newList /Transfer/ ); |
|
|
void setTransparentThreeValuePixelList( const QList<QgsRasterTransparency::TransparentThreeValuePixel> &newList ); |
|
|
%Docstring |
|
|
Mutator for transparentThreeValuePixelList, replaces the whole list |
|
|
Sets the transparent three value pixel list, replacing the whole existing list. |
|
|
%End |
|
|
|
|
|
int alphaValue( double value, int globalTransparency = 255 ) const; |
|
|
|
@@ -43,11 +43,17 @@ class CORE_EXPORT QgsContrastEnhancementFunction |
|
|
//! \brief A customicable method to indicate if the pixels is displayable |
|
|
virtual bool isValueInDisplayableRange( double ); |
|
|
|
|
|
//! \brief Mustator for the maximum value |
|
|
void setMaximumValue( double ); |
|
|
/** |
|
|
* Sets the maximum \a value. |
|
|
* \see setMinimumValue() |
|
|
*/ |
|
|
void setMaximumValue( double value ); |
|
|
|
|
|
//! \brief Mutator for the minimum value |
|
|
void setMinimumValue( double ); |
|
|
/** |
|
|
* Sets the minimum \a value. |
|
|
* \see setMaximumValue() |
|
|
*/ |
|
|
void setMinimumValue( double value ); |
|
|
|
|
|
protected: |
|
|
//! \brief User defineable maximum value for the band, used for enhanceContrasting |
|
|
|
@@ -76,11 +76,15 @@ class CORE_EXPORT QgsRasterTransparency |
|
|
*/ |
|
|
void initializeTransparentPixelList( double redValue, double greenValue, double blueValue ); |
|
|
|
|
|
//! \brief Mutator for transparentSingleValuePixelList, replaces the whole list |
|
|
void setTransparentSingleValuePixelList( const QList<QgsRasterTransparency::TransparentSingleValuePixel> &newList SIP_TRANSFER ); |
|
|
/** |
|
|
* Sets the transparent single value pixel list, replacing the whole existing list. |
|
|
*/ |
|
|
void setTransparentSingleValuePixelList( const QList<QgsRasterTransparency::TransparentSingleValuePixel> &newList ); |
|
|
|
|
|
//! \brief Mutator for transparentThreeValuePixelList, replaces the whole list |
|
|
void setTransparentThreeValuePixelList( const QList<QgsRasterTransparency::TransparentThreeValuePixel> &newList SIP_TRANSFER ); |
|
|
/** |
|
|
* Sets the transparent three value pixel list, replacing the whole existing list. |
|
|
*/ |
|
|
void setTransparentThreeValuePixelList( const QList<QgsRasterTransparency::TransparentThreeValuePixel> &newList ); |
|
|
|
|
|
/** |
|
|
* Returns the transparency value for a single \a value pixel. |
|
|
|
@@ -577,6 +577,8 @@ def memberDocIsNonCompliant(self, member_elem): |
|
|
return 'Use "Returns the..." instead of "getter"' |
|
|
elif para.text.strip().lower().startswith('setter'): |
|
|
return 'Use "Sets the..." instead of "setter"' |
|
|
elif para.text.strip().lower().startswith('mutator'): |
|
|
return 'Use "Sets the..." instead of "mutator for..."' |
|
|
elif para.text.strip().lower().startswith('return '): |
|
|
return 'Use "Returns the..." instead of "return ..."' |
|
|
#elif para.text.strip().lower().startswith('set '): |
|
|