commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ki...@apache.org
Subject [commons-imaging] branch master updated: [IMAGING-146]: add javadoc comments to the color package
Date Sun, 15 Dec 2019 22:45:29 GMT
This is an automated email from the ASF dual-hosted git repository.

kinow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git


The following commit(s) were added to refs/heads/master by this push:
     new 2828140  [IMAGING-146]: add javadoc comments to the color package
     new 6b1d127  Merge pull request #65 from kinow/IMAGING-146
2828140 is described below

commit 282814065819cc411b8282dfb9e37c3d30aaab04
Author: Bruno P. Kinoshita <kinow@apache.org>
AuthorDate: Sun Dec 15 16:40:43 2019 +1300

    [IMAGING-146]: add javadoc comments to the color package
---
 src/changes/changes.xml                                        |  3 +++
 .../java/org/apache/commons/imaging/color/ColorCieLab.java     | 10 ++++++++++
 .../java/org/apache/commons/imaging/color/ColorCieLch.java     |  9 +++++++++
 .../java/org/apache/commons/imaging/color/ColorCieLuv.java     |  9 +++++++++
 src/main/java/org/apache/commons/imaging/color/ColorCmy.java   |  9 +++++++++
 src/main/java/org/apache/commons/imaging/color/ColorCmyk.java  |  9 +++++++++
 src/main/java/org/apache/commons/imaging/color/ColorHsl.java   |  9 +++++++++
 src/main/java/org/apache/commons/imaging/color/ColorHsv.java   |  9 +++++++++
 .../java/org/apache/commons/imaging/color/ColorHunterLab.java  |  9 +++++++++
 src/main/java/org/apache/commons/imaging/color/ColorXyz.java   | 10 ++++++++++
 10 files changed, 86 insertions(+)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 3e5619b..c2274e0 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -45,6 +45,9 @@ The <action> type attribute can be add,update,fix,remove.
   </properties>
   <body>
     <release version="1.0-alpha2" date="2019-??-??" description="Second 1.0 alpha release">
+      <action issue="IMAGING-146" dev="kinow" type="add">
+        Add documentation for the color package
+      </action>
       <action issue="IMAGING-243" dev="kinow" type="add" due-to="Andreas Menze">
         PNG Writer Indexed Color with semi-transparent Pixels and Better Compression
       </action>
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 5e1ad64..39e57b0 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLab.java
@@ -16,6 +16,16 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CIELAB color space, also
+ * known as LAB color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, and blue.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CIELAB_color_space#CIELAB">https://en.wikipedia.org/wiki/CIELAB_color_space#CIELAB</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorCieLab {
 
     /**
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 77be4dd..bcb9ed4 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLch.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CIELCH color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, and blue.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CIELUV#Cylindrical_representation_(CIELCH)">https://en.wikipedia.org/wiki/CIELUV#Cylindrical_representation_(CIELCH)</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorCieLch {
 
     /**
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 da96e88..f24299b 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCieLuv.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CIELUV color space..
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, and blue.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CIELUV">https://en.wikipedia.org/wiki/CIELUV</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorCieLuv {
 
     /**
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 39f0f23..4dfb700 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCmy.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CMY color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, blue, cyan, magenta, and yellow.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CMY_color_model">https://en.wikipedia.org/wiki/CMY_color_model</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorCmy {
 
     /**
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 6c2b29c..41a9f91 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorCmyk.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CMYK color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, blue, cyan, magenta, and yellow.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CMYK_color_model">https://en.wikipedia.org/wiki/CMYK_color_model</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorCmyk {
 
     /**
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorHsl.java b/src/main/java/org/apache/commons/imaging/color/ColorHsl.java
index 00f645d..46ba6bb 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorHsl.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorHsl.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the HSL color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, blue, cyan, magenta, and yellow.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">https://en.wikipedia.org/wiki/HSL_and_HSV</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorHsl {
 
     /**
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorHsv.java b/src/main/java/org/apache/commons/imaging/color/ColorHsv.java
index 6dd1fa1..7bb8981 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorHsv.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorHsv.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the HSV color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, blue, cyan, magenta, and yellow.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">https://en.wikipedia.org/wiki/HSL_and_HSV</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorHsv {
 
     /**
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorHunterLab.java b/src/main/java/org/apache/commons/imaging/color/ColorHunterLab.java
index 4a0e482..12ceea0 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorHunterLab.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorHunterLab.java
@@ -16,6 +16,15 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the Hunter Lab color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, and blue.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CIELAB_color_space#Hunter_Lab">https://en.wikipedia.org/wiki/CIELAB_color_space#Hunter_Lab</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorHunterLab {
 
     /**
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorXyz.java b/src/main/java/org/apache/commons/imaging/color/ColorXyz.java
index 629edfe..ec26acd 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorXyz.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorXyz.java
@@ -16,6 +16,16 @@
  */
 package org.apache.commons.imaging.color;
 
+/**
+ * Represents a color in the CIE 1931 color space, also
+ * known as XYZ color space.
+ *
+ * <p>Contains the constant values for black, white, red,
+ * green, and blue.</p>
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">https://en.wikipedia.org/wiki/CIE_1931_color_space</a>
+ * @since 1.0-alpha1
+ */
 public final class ColorXyz {
 
     /**


Mime
View raw message