From a004df192ab172585ade0887bf49018333dbb0b4 Mon Sep 17 00:00:00 2001 From: jules Date: Sun, 1 Nov 2015 18:11:13 +0000 Subject: [PATCH] Corrected some documentation. --- modules/juce_graphics/colour/juce_Colour.h | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/modules/juce_graphics/colour/juce_Colour.h b/modules/juce_graphics/colour/juce_Colour.h index 885eaa301f..85abc04efd 100644 --- a/modules/juce_graphics/colour/juce_Colour.h +++ b/modules/juce_graphics/colour/juce_Colour.h @@ -282,30 +282,25 @@ public: Colour withBrightness (float newBrightness) const noexcept; /** Returns a copy of this colour with it hue rotated. - The new colour's hue is ((this->getHue() + amountToRotate) % 1.0) - @see brighter, darker, withMultipliedBrightness */ Colour withRotatedHue (float amountToRotate) const noexcept; /** Returns a copy of this colour with its saturation multiplied by the given value. - The new colour's saturation is (this->getSaturation() * multiplier) (the result is clipped to legal limits). */ Colour withMultipliedSaturation (float multiplier) const noexcept; /** Returns a copy of this colour with its brightness multiplied by the given value. - - The new colour's saturation is (this->getBrightness() * multiplier) + The new colour's brightness is (this->getBrightness() * multiplier) (the result is clipped to legal limits). */ Colour withMultipliedBrightness (float amount) const noexcept; //============================================================================== /** Returns a brighter version of this colour. - @param amountBrighter how much brighter to make it - a value from 0 to 1.0 where 0 is unchanged, and higher values make it brighter @see withMultipliedBrightness @@ -313,7 +308,6 @@ public: Colour brighter (float amountBrighter = 0.4f) const noexcept; /** Returns a darker version of this colour. - @param amountDarker how much darker to make it - a value from 0 to 1.0 where 0 is unchanged, and higher values make it darker @see withMultipliedBrightness