Skip to content

Commit a0ef309

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent a647432 commit a0ef309

File tree

5 files changed

+93
-41
lines changed

5 files changed

+93
-41
lines changed

‎src/main/java/org/apache/commons/imaging/color/ColorCieLab.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ public final class ColorCieLab {
3232
* A constant for color black. Color components are:
3333
*
3434
* <pre>
35-
* L: 0
36-
* a: 0
37-
* b: 0
35+
* L*: 0
36+
* a*: 0
37+
* b*: 0
3838
* </pre>
3939
*/
4040
public static final ColorCieLab BLACK = new ColorCieLab(0, 0, 0);
@@ -43,9 +43,9 @@ public final class ColorCieLab {
4343
* A constant for color white. Color components are:
4444
*
4545
* <pre>
46-
* L: 100
47-
* a: 0
48-
* b: 0
46+
* L*: 100
47+
* a*: 0
48+
* b*: 0
4949
* </pre>
5050
*/
5151
public static final ColorCieLab WHITE = new ColorCieLab(100, 0, 0);
@@ -54,9 +54,9 @@ public final class ColorCieLab {
5454
* A constant for color red. Color components are:
5555
*
5656
* <pre>
57-
* L: 53
58-
* a: 80
59-
* b: 67
57+
* L*: 53
58+
* a*: 80
59+
* b*: 67
6060
* </pre>
6161
*/
6262
public static final ColorCieLab RED = new ColorCieLab(53, 80, 67);
@@ -65,9 +65,9 @@ public final class ColorCieLab {
6565
* A constant for color green. Color components are:
6666
*
6767
* <pre>
68-
* L: 88
69-
* a: -86
70-
* b: 83
68+
* L*: 88
69+
* a*: -86
70+
* b*: 83
7171
* </pre>
7272
*/
7373
public static final ColorCieLab GREEN = new ColorCieLab(88, -86, 83);
@@ -76,14 +76,14 @@ public final class ColorCieLab {
7676
* A constant for color blue. Color components are:
7777
*
7878
* <pre>
79-
* L: 32
80-
* a: 79
81-
* b: -108
79+
* L*: 32
80+
* a*: 79
81+
* b*: -108
8282
* </pre>
8383
*/
8484
public static final ColorCieLab BLUE = new ColorCieLab(32, 79, -108);
8585

86-
/** lightness L*. */
86+
/** Lightness L*. */
8787
public final double l;
8888

8989
/** a* value. */

‎src/main/java/org/apache/commons/imaging/color/ColorCieLch.java‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ public final class ColorCieLch {
3333
* A constant for color black. Color components are:
3434
*
3535
* <pre>
36-
* L: 0
37-
* c: 0
36+
* L*: 0
37+
* C*: 0
3838
* h: 0
3939
* </pre>
4040
*/
@@ -44,8 +44,8 @@ public final class ColorCieLch {
4444
* A constant for color white. Color components are:
4545
*
4646
* <pre>
47-
* L: 100
48-
* c: 0
47+
* L*: 100
48+
* C*: 0
4949
* h: 297
5050
* </pre>
5151
*/
@@ -55,8 +55,8 @@ public final class ColorCieLch {
5555
* A constant for color red. Color components are:
5656
*
5757
* <pre>
58-
* L: 53
59-
* c: 80
58+
* L*: 53
59+
* C*: 80
6060
* h: 67
6161
* </pre>
6262
*/
@@ -66,8 +66,8 @@ public final class ColorCieLch {
6666
* A constant for color green. Color components are:
6767
*
6868
* <pre>
69-
* L: 88
70-
* c: -86
69+
* L*: 88
70+
* C*: -86
7171
* h: 83
7272
* </pre>
7373
*/
@@ -77,17 +77,29 @@ public final class ColorCieLch {
7777
* A constant for color blue. Color components are:
7878
*
7979
* <pre>
80-
* L: 32
81-
* c: 79
80+
* L*: 32
81+
* C*: 79
8282
* h: -108
8383
* </pre>
8484
*/
8585
public static final ColorCieLch BLUE = new ColorCieLch(32, 79, -108);
8686

87+
/** L* lightness. */
8788
public final double l;
89+
90+
/** C* chroma. */
8891
public final double c;
92+
93+
/** Hue. */
8994
public final double h;
9095

96+
/**
97+
* Constructs a new instance.
98+
*
99+
* @param l L* lightness.
100+
* @param c chroma.
101+
* @param h hue.
102+
*/
91103
public ColorCieLch(final double l, final double c, final double h) {
92104
this.l = l;
93105
this.c = c;

‎src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java‎

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ public final class ColorCieLuv {
3232
* A constant for color black. Color components are:
3333
*
3434
* <pre>
35-
* L: 0.000
36-
* u: 0.000
37-
* v: 0.000
35+
* L*: 0.000
36+
* u*: 0.000
37+
* v*: 0.000
3838
* </pre>
3939
*/
4040
public static final ColorCieLuv BLACK = new ColorCieLuv(0, 0, 0);
@@ -43,9 +43,9 @@ public final class ColorCieLuv {
4343
* A constant for color white. Color components are:
4444
*
4545
* <pre>
46-
* L: 100.000
47-
* u: 0.000
48-
* v: -0.017
46+
* L*: 100.000
47+
* u*: 0.000
48+
* v*: -0.017
4949
* </pre>
5050
*/
5151
public static final ColorCieLuv WHITE = new ColorCieLuv(100, 0, -0.017);
@@ -54,9 +54,9 @@ public final class ColorCieLuv {
5454
* A constant for color red. Color components are:
5555
*
5656
* <pre>
57-
* L: 53.233
58-
* u: 175.053
59-
* v: 37.751
57+
* L*: 53.233
58+
* u*: 175.053
59+
* v*: 37.751
6060
* </pre>
6161
*/
6262
public static final ColorCieLuv RED = new ColorCieLuv(53.233, 175.053, 37.751);
@@ -65,9 +65,9 @@ public final class ColorCieLuv {
6565
* A constant for color green. Color components are:
6666
*
6767
* <pre>
68-
* L: 87.737
69-
* u: -83.080
70-
* v: 107.401
68+
* L*: 87.737
69+
* u*: -83.080
70+
* v*: 107.401
7171
* </pre>
7272
*/
7373
public static final ColorCieLuv GREEN = new ColorCieLuv(87.737, -83.080, 107.401);
@@ -76,17 +76,29 @@ public final class ColorCieLuv {
7676
* A constant for color blue. Color components are:
7777
*
7878
* <pre>
79-
* L: 32.303
80-
* u: -9.400
81-
* v: -130.358
79+
* L*: 32.303
80+
* u*: -9.400
81+
* v*: -130.358
8282
* </pre>
8383
*/
8484
public static final ColorCieLuv BLUE = new ColorCieLuv(32.303, -9.400, -130.358);
8585

86+
/** Luminance L*. */
8687
public final double l;
88+
89+
/** Chromaticity component u*. */
8790
public final double u;
91+
92+
/** Chromaticity component v*. */
8893
public final double v;
8994

95+
/**
96+
* Constructs a new instance.
97+
*
98+
* @param l Luminance L*.
99+
* @param u Chromaticity component u*.
100+
* @param v Chromaticity component v*.
101+
*/
90102
public ColorCieLuv(final double l, final double u, final double v) {
91103
this.l = l;
92104
this.u = u;

‎src/main/java/org/apache/commons/imaging/color/ColorCmy.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,23 @@ public final class ColorCmy {
116116
*/
117117
public static final ColorCmy BLUE = new ColorCmy(100, 100, 0);
118118

119+
120+
/** Cyan. */
119121
public final double c;
122+
123+
/** Magenta. */
120124
public final double m;
125+
126+
/** Yellow. */
121127
public final double y;
122128

129+
/**
130+
* Constructs a new instance.
131+
*
132+
* @param c cyan.
133+
* @param m magenta.
134+
* @param y yellow.
135+
*/
123136
public ColorCmy(final double c, final double m, final double y) {
124137
this.c = c;
125138
this.m = m;

‎src/main/java/org/apache/commons/imaging/color/ColorCmyk.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,26 @@ public final class ColorCmyk {
124124
*/
125125
public static final ColorCmyk BLUE = new ColorCmyk(100, 100, 0, 0);
126126

127+
/** Cyan. */
127128
public final double c;
129+
130+
/** Magenta. */
128131
public final double m;
132+
133+
/** Yellow. */
129134
public final double y;
135+
136+
/** Key. */
130137
public final double k;
131138

139+
/**
140+
* Constructs a new instance.
141+
*
142+
* @param c cyan.
143+
* @param m magenta.
144+
* @param y yellow.
145+
* @param k key.
146+
*/
132147
public ColorCmyk(final double c, final double m, final double y, final double k) {
133148
this.c = c;
134149
this.m = m;

0 commit comments

Comments
 (0)