This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git
commit a0ef30981f500d541e5ffbef313b7b25404bed2e
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Feb 21 22:04:42 2025 -0500
Javadoc
---
.../apache/commons/imaging/color/ColorCieLab.java | 32 ++++++++---------
.../apache/commons/imaging/color/ColorCieLch.java | 32 +++++++++++------
.../apache/commons/imaging/color/ColorCieLuv.java | 42 ++++++++++++++--------
.../org/apache/commons/imaging/color/ColorCmy.java | 13 +++++++
.../apache/commons/imaging/color/ColorCmyk.java | 15 ++++++++
5 files changed, 93 insertions(+), 41 deletions(-)
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
b/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
index ca48ad37..77c7ce9e 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
@@ -32,9 +32,9 @@ public final class ColorCieLab {
* A constant for color black. Color components are:
*
* <pre>
- * L: 0
- * a: 0
- * b: 0
+ * L*: 0
+ * a*: 0
+ * b*: 0
* </pre>
*/
public static final ColorCieLab BLACK = new ColorCieLab(0, 0, 0);
@@ -43,9 +43,9 @@ public final class ColorCieLab {
* A constant for color white. Color components are:
*
* <pre>
- * L: 100
- * a: 0
- * b: 0
+ * L*: 100
+ * a*: 0
+ * b*: 0
* </pre>
*/
public static final ColorCieLab WHITE = new ColorCieLab(100, 0, 0);
@@ -54,9 +54,9 @@ public final class ColorCieLab {
* A constant for color red. Color components are:
*
* <pre>
- * L: 53
- * a: 80
- * b: 67
+ * L*: 53
+ * a*: 80
+ * b*: 67
* </pre>
*/
public static final ColorCieLab RED = new ColorCieLab(53, 80, 67);
@@ -65,9 +65,9 @@ public final class ColorCieLab {
* A constant for color green. Color components are:
*
* <pre>
- * L: 88
- * a: -86
- * b: 83
+ * L*: 88
+ * a*: -86
+ * b*: 83
* </pre>
*/
public static final ColorCieLab GREEN = new ColorCieLab(88, -86, 83);
@@ -76,14 +76,14 @@ public final class ColorCieLab {
* A constant for color blue. Color components are:
*
* <pre>
- * L: 32
- * a: 79
- * b: -108
+ * L*: 32
+ * a*: 79
+ * b*: -108
* </pre>
*/
public static final ColorCieLab BLUE = new ColorCieLab(32, 79, -108);
- /** lightness L*. */
+ /** Lightness L*. */
public final double l;
/** a* value. */
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
b/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
index 974fdc3e..dcbed9c7 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
@@ -33,8 +33,8 @@ public final class ColorCieLch {
* A constant for color black. Color components are:
*
* <pre>
- * L: 0
- * c: 0
+ * L*: 0
+ * C*: 0
* h: 0
* </pre>
*/
@@ -44,8 +44,8 @@ public final class ColorCieLch {
* A constant for color white. Color components are:
*
* <pre>
- * L: 100
- * c: 0
+ * L*: 100
+ * C*: 0
* h: 297
* </pre>
*/
@@ -55,8 +55,8 @@ public final class ColorCieLch {
* A constant for color red. Color components are:
*
* <pre>
- * L: 53
- * c: 80
+ * L*: 53
+ * C*: 80
* h: 67
* </pre>
*/
@@ -66,8 +66,8 @@ public final class ColorCieLch {
* A constant for color green. Color components are:
*
* <pre>
- * L: 88
- * c: -86
+ * L*: 88
+ * C*: -86
* h: 83
* </pre>
*/
@@ -77,17 +77,29 @@ public final class ColorCieLch {
* A constant for color blue. Color components are:
*
* <pre>
- * L: 32
- * c: 79
+ * L*: 32
+ * C*: 79
* h: -108
* </pre>
*/
public static final ColorCieLch BLUE = new ColorCieLch(32, 79, -108);
+ /** L* lightness. */
public final double l;
+
+ /** C* chroma. */
public final double c;
+
+ /** Hue. */
public final double h;
+ /**
+ * Constructs a new instance.
+ *
+ * @param l L* lightness.
+ * @param c chroma.
+ * @param h hue.
+ */
public ColorCieLch(final double l, final double c, final double h) {
this.l = l;
this.c = c;
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
b/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
index d4299779..7eeab93c 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
@@ -32,9 +32,9 @@ public final class ColorCieLuv {
* A constant for color black. Color components are:
*
* <pre>
- * L: 0.000
- * u: 0.000
- * v: 0.000
+ * L*: 0.000
+ * u*: 0.000
+ * v*: 0.000
* </pre>
*/
public static final ColorCieLuv BLACK = new ColorCieLuv(0, 0, 0);
@@ -43,9 +43,9 @@ public final class ColorCieLuv {
* A constant for color white. Color components are:
*
* <pre>
- * L: 100.000
- * u: 0.000
- * v: -0.017
+ * L*: 100.000
+ * u*: 0.000
+ * v*: -0.017
* </pre>
*/
public static final ColorCieLuv WHITE = new ColorCieLuv(100, 0, -0.017);
@@ -54,9 +54,9 @@ public final class ColorCieLuv {
* A constant for color red. Color components are:
*
* <pre>
- * L: 53.233
- * u: 175.053
- * v: 37.751
+ * L*: 53.233
+ * u*: 175.053
+ * v*: 37.751
* </pre>
*/
public static final ColorCieLuv RED = new ColorCieLuv(53.233, 175.053,
37.751);
@@ -65,9 +65,9 @@ public final class ColorCieLuv {
* A constant for color green. Color components are:
*
* <pre>
- * L: 87.737
- * u: -83.080
- * v: 107.401
+ * L*: 87.737
+ * u*: -83.080
+ * v*: 107.401
* </pre>
*/
public static final ColorCieLuv GREEN = new ColorCieLuv(87.737, -83.080,
107.401);
@@ -76,17 +76,29 @@ public final class ColorCieLuv {
* A constant for color blue. Color components are:
*
* <pre>
- * L: 32.303
- * u: -9.400
- * v: -130.358
+ * L*: 32.303
+ * u*: -9.400
+ * v*: -130.358
* </pre>
*/
public static final ColorCieLuv BLUE = new ColorCieLuv(32.303, -9.400,
-130.358);
+ /** Luminance L*. */
public final double l;
+
+ /** Chromaticity component u*. */
public final double u;
+
+ /** Chromaticity component v*. */
public final double v;
+ /**
+ * Constructs a new instance.
+ *
+ * @param l Luminance L*.
+ * @param u Chromaticity component u*.
+ * @param v Chromaticity component v*.
+ */
public ColorCieLuv(final double l, final double u, final double v) {
this.l = l;
this.u = u;
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
b/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
index f88ebfe7..f6287821 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
@@ -116,10 +116,23 @@ public final class ColorCmy {
*/
public static final ColorCmy BLUE = new ColorCmy(100, 100, 0);
+
+ /** Cyan. */
public final double c;
+
+ /** Magenta. */
public final double m;
+
+ /** Yellow. */
public final double y;
+ /**
+ * Constructs a new instance.
+ *
+ * @param c cyan.
+ * @param m magenta.
+ * @param y yellow.
+ */
public ColorCmy(final double c, final double m, final double y) {
this.c = c;
this.m = m;
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
b/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
index b904534d..c59a3d6a 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
@@ -124,11 +124,26 @@ public final class ColorCmyk {
*/
public static final ColorCmyk BLUE = new ColorCmyk(100, 100, 0, 0);
+ /** Cyan. */
public final double c;
+
+ /** Magenta. */
public final double m;
+
+ /** Yellow. */
public final double y;
+
+ /** Key. */
public final double k;
+ /**
+ * Constructs a new instance.
+ *
+ * @param c cyan.
+ * @param m magenta.
+ * @param y yellow.
+ * @param k key.
+ */
public ColorCmyk(final double c, final double m, final double y, final
double k) {
this.c = c;
this.m = m;
