[gnus git] branch master updated: m0-5-139-g91877dd =1= color.el: Doc fixes
Katsumi Yamaoka <[email protected]>
| Newsgroups | gmane.emacs.gnus.cvs |
|---|---|
| Message-ID | <[email protected]> |
via 91877dd7268b22b79f377b4e1dcd4fed2b458f8e (commit)
from 5365de3680bcee2f3eefd8072cc7e19eedf84165 (commit)
- Log -----------------------------------------------------------------
commit 91877dd7268b22b79f377b4e1dcd4fed2b458f8e
Author: Glenn Morris <[email protected]>
Date: Fri Oct 5 09:29:15 2012 +0000
color.el: Doc fixes
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index b2c73aa..a09a02d 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,11 @@
+2012-10-05 Glenn Morris <[email protected]>
+
+ * color.el (color-name-to-rgb, color-rgb-to-hex)
+ (color-hue-to-rgb, color-hsl-to-rgb, color-rgb-to-hsv)
+ (color-rgb-to-hsl, color-srgb-to-xyz, color-saturate-hsl)
+ (color-desaturate-hsl, color-desaturate-name, color-lighten-hsl)
+ (color-lighten-name, color-darken-hsl, color-darken-name): Doc fixes.
+
2012-09-25 Katsumi Yamaoka <[email protected]>
* gnus-art.el (gnus-article-browse-delete-temp-files): Never ask again
diff --git a/lisp/color.el b/lisp/color.el
index 6ccf9a7..39b172d 100644
--- a/lisp/color.el
+++ b/lisp/color.el
@@ -50,7 +50,7 @@ string (e.g. \"#ff12ec\").
Normally the return value is a list of three floating-point
numbers, (RED GREEN BLUE), each between 0.0 and 1.0 inclusive.
-Optional arg FRAME specifies the frame where the color is to be
+Optional argument FRAME specifies the frame where the color is to be
displayed. If FRAME is omitted or nil, use the selected frame.
If FRAME cannot display COLOR, return nil."
;; `colors-values' maximum value is either 65535 or 65280 depending on the
@@ -60,7 +60,7 @@ If FRAME cannot display COLOR, return nil."
(defun color-rgb-to-hex (red green blue)
"Return hexadecimal notation for the color RED GREEN BLUE.
-RED GREEN BLUE must be numbers between 0.0 and 1.0 inclusive."
+RED, GREEN, and BLUE should be numbers between 0.0 and 1.0, inclusive."
(format "#%02x%02x%02x"
(* red 255) (* green 255) (* blue 255)))
@@ -93,8 +93,8 @@ resulting list."
(nreverse result)))
(defun color-hue-to-rgb (v1 v2 h)
- "Compute hue from V1 and V2 H. Internally used by
-`color-hsl-to-rgb'."
+ "Compute hue from V1 and V2 H.
+Used internally by `color-hsl-to-rgb'."
(cond
((< h (/ 1.0 6)) (+ v1 (* (- v2 v1) h 6.0)))
((< h 0.5) v2)
@@ -102,13 +102,10 @@ resulting list."
(t v1)))
(defun color-hsl-to-rgb (H S L)
- "Convert H S L (HUE, SATURATION, LUMINANCE) , where HUE is in
-radians and both SATURATION and LUMINANCE are between 0.0 and
-1.0, inclusive to their RGB representation.
-
-Return a list (RED, GREEN, BLUE) which each be numbers between
-0.0 and 1.0, inclusive."
-
+ "Convert hue, saturation and luminance to their RGB representation.
+H, S, and L should each be numbers between 0.0 and 1.0, inclusive.
+Return a list (RED GREEN BLUE), where each element is between 0.0 and 1.0,
+inclusive."
(if (= S 0.0)
(list L L L)
(let* ((m2 (if (<= L 0.5)
@@ -125,9 +122,9 @@ Return a list (RED, GREEN, BLUE) which each be numbers between
(apply 'color-rgb-to-hex (color-complement color)))
(defun color-rgb-to-hsv (red green blue)
- "Convert RED, GREEN, and BLUE color components to HSV.
+ "Convert RGB color components to HSV.
RED, GREEN, and BLUE should each be numbers between 0.0 and 1.0,
-inclusive. Return a list (HUE, SATURATION, VALUE), where HUE is
+inclusive. Return a list (HUE SATURATION VALUE), where HUE is
in radians and both SATURATION and VALUE are between 0.0 and 1.0,
inclusive."
(let* ((r (float red))
@@ -155,13 +152,10 @@ inclusive."
(/ max 255.0)))))
(defun color-rgb-to-hsl (red green blue)
- "Convert RED GREEN BLUE colors to their HSL representation.
+ "Convert RGB colors to their HSL representation.
RED, GREEN, and BLUE should each be numbers between 0.0 and 1.0,
-inclusive.
-
-Return a list (HUE, SATURATION, LUMINANCE), where HUE is in radians
-and both SATURATION and LUMINANCE are between 0.0 and 1.0,
-inclusive."
+inclusive. Return a list (HUE SATURATION LUMINANCE), where
+each element is between 0.0 and 1.0, inclusive."
(let* ((r red)
(g green)
(b blue)
@@ -187,7 +181,7 @@ inclusive."
(defun color-srgb-to-xyz (red green blue)
"Convert RED GREEN BLUE colors from the sRGB color space to CIE XYZ.
-RED, BLUE and GREEN must be between 0 and 1, inclusive."
+RED, GREEN and BLUE should be between 0.0 and 1.0, inclusive."
(let ((r (if (<= red 0.04045)
(/ red 12.95)
(expt (/ (+ red 0.055) 1.055) 2.4)))
@@ -344,17 +338,14 @@ returned by `color-srgb-to-lab' or `color-xyz-to-lab'."
(min 1.0 (max 0.0 value)))
(defun color-saturate-hsl (H S L percent)
- "Return a color PERCENT more saturated than the one defined in
-H S L color-space.
-
-Return a list (HUE, SATURATION, LUMINANCE), where HUE is in radians
-and both SATURATION and LUMINANCE are between 0.0 and 1.0,
-inclusive."
+ "Make a color more saturated by a specified amount.
+Given a color defined in terms of hue, saturation, and luminance
+\(arguments H, S, and L), return a color that is PERCENT more
+saturated. Returns a list (HUE SATURATION LUMINANCE)."
(list H (color-clamp (+ S (/ percent 100.0))) L))
(defun color-saturate-name (name percent)
- "Short hand to saturate COLOR by PERCENT.
-
+ "Make a color with a specified NAME more saturated by PERCENT.
See `color-saturate-hsl'."
(apply 'color-rgb-to-hex
(apply 'color-hsl-to-rgb
@@ -365,32 +356,26 @@ See `color-saturate-hsl'."
(list percent))))))
(defun color-desaturate-hsl (H S L percent)
- "Return a color PERCENT less saturated than the one defined in
-H S L color-space.
-
-Return a list (HUE, SATURATION, LUMINANCE), where HUE is in radians
-and both SATURATION and LUMINANCE are between 0.0 and 1.0,
-inclusive."
+ "Make a color less saturated by a specified amount.
+Given a color defined in terms of hue, saturation, and luminance
+\(arguments H, S, and L), return a color that is PERCENT less
+saturated. Returns a list (HUE SATURATION LUMINANCE)."
(color-saturate-hsl H S L (- percent)))
(defun color-desaturate-name (name percent)
- "Short hand to desaturate COLOR by PERCENT.
-
+ "Make a color with a specified NAME less saturated by PERCENT.
See `color-desaturate-hsl'."
(color-saturate-name name (- percent)))
(defun color-lighten-hsl (H S L percent)
- "Return a color PERCENT lighter than the one defined in
-H S L color-space.
-
-Return a list (HUE, SATURATION, LUMINANCE), where HUE is in radians
-and both SATURATION and LUMINANCE are between 0.0 and 1.0,
-inclusive."
+ "Make a color lighter by a specified amount.
+Given a color defined in terms of hue, saturation, and luminance
+\(arguments H, S, and L), return a color that is PERCENT lighter.
+Returns a list (HUE SATURATION LUMINANCE)."
(list H S (color-clamp (+ L (/ percent 100.0)))))
(defun color-lighten-name (name percent)
- "Short hand to saturate COLOR by PERCENT.
-
+ "Make a color with a specified NAME lighter by PERCENT.
See `color-lighten-hsl'."
(apply 'color-rgb-to-hex
(apply 'color-hsl-to-rgb
@@ -401,17 +386,14 @@ See `color-lighten-hsl'."
(list percent))))))
(defun color-darken-hsl (H S L percent)
- "Return a color PERCENT darker than the one defined in
-H S L color-space.
-
-Return a list (HUE, SATURATION, LUMINANCE), where HUE is in radians
-and both SATURATION and LUMINANCE are between 0.0 and 1.0,
-inclusive."
+ "Make a color darker by a specified amount.
+Given a color defined in terms of hue, saturation, and luminance
+\(arguments H, S, and L), return a color that is PERCENT darker.
+Returns a list (HUE SATURATION LUMINANCE)."
(color-lighten-hsl H S L (- percent)))
(defun color-darken-name (name percent)
- "Short hand to saturate COLOR by PERCENT.
-
+ "Make a color with a specified NAME darker by PERCENT.
See `color-darken-hsl'."
(color-lighten-name name (- percent)))
-----------------------------------------------------------------------
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we listed those
revisions in full, above.
Summary of changes:
lisp/ChangeLog | 8 +++++
lisp/color.el | 94 ++++++++++++++++++++++---------------------------------
2 files changed, 46 insertions(+), 56 deletions(-)
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Gnus Project".
The branch, master has been updated
hooks/post-receive
--
Gnus Project