xmlgraphics-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jerem...@apache.org
Subject svn commit: r1028223 - /xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java
Date Thu, 28 Oct 2010 08:46:44 GMT
Author: jeremias
Date: Thu Oct 28 08:46:44 2010
New Revision: 1028223

URL: http://svn.apache.org/viewvc?rev=1028223&view=rev
Log:
Fixed javadoc generation warnings.

Modified:
    xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java

Modified: xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java
URL: http://svn.apache.org/viewvc/xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java?rev=1028223&r1=1028222&r2=1028223&view=diff
==============================================================================
--- xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java
(original)
+++ xmlgraphics/commons/branches/Temp_Color/src/java/org/apache/xmlgraphics/java2d/color/CIELabColorSpace.java
Thu Oct 28 08:46:44 2010
@@ -209,7 +209,16 @@ public class CIELabColorSpace extends Co
         return toCIEXYZNative(l, a, b);
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Transforms a color value assumed to be in this {@link ColorSpace}
+     * into the CS_CIEXYZ conversion color space. This method uses component values
+     * in CIE Lab's native color ranges rather than the normalized values between 0 and 1.
+     * @param l the L* component (values between 0 and 100)
+     * @param a the a* component (usually between -128 and +128)
+     * @param b the b* component (usually between -128 and +128)
+     * @return the XYZ color values
+     * @see #toCIEXYZ(float[])
+     */
     public float[] toCIEXYZNative(float l, float a, float b) {
         double varY = (l + 16) / 116.0;
         double varX = a / 500 + varY;
@@ -292,10 +301,10 @@ public class CIELabColorSpace extends Co
     /**
      * Creates a {@link Color} instance from color values usually used by the L*a*b* color
space
      * by scaling them to the 0.0..1.0 range expected by Color's constructor.
-     * @param l the L* component
-     * @param a the a* component
-     * @param b the b* component
-     * @param alpha the alpha component
+     * @param l the L* component (values between 0 and 100)
+     * @param a the a* component (usually between -128 and +127)
+     * @param b the b* component (usually between -128 and +127)
+     * @param alpha the alpha component (values between 0 and 1)
      * @return the requested color instance
      */
     public Color toColor(float l, float a, float b, float alpha) {



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org


Mime
View raw message