Javadoc update.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/commons/branches/Temp_Color@1045096 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/xmlgraphics/java2d/color/ColorWithAlternatives.java b/src/java/org/apache/xmlgraphics/java2d/color/ColorWithAlternatives.java
index bfb8155..33cdc15 100644
--- a/src/java/org/apache/xmlgraphics/java2d/color/ColorWithAlternatives.java
+++ b/src/java/org/apache/xmlgraphics/java2d/color/ColorWithAlternatives.java
@@ -27,11 +27,14 @@
* The alternative colors shall be the ones that are preferred if an output format supports them.
* This is normally used for passing device-specific colors through to the output format.
* <p>
- * An additional benefit of this class is a better {@link ColorWithAlternatives#equals(Object)}
- * method than the one from {@link Color} which only takes the sRGB values into account.
- * <p>
* This class only adds a single reference to a color array which should not increase memory
* consumption by much if no alternative colors are specified.
+ * <p>
+ * <b>Important:</b> Due to a flaw in {@link Color#equals(Object)}, the <code>equals()</code>
+ * method should not be used to compare two colors, especially when used to update the current
+ * color for some output format. {@link Color} only takes the sRGB values into account but not
+ * more the advanced facets of this class. Use {@link ColorUtil#isSameColor(Color, Color)} for
+ * such a check.
*/
public class ColorWithAlternatives extends Color {
