Revision: 84
http://patchanim.svn.sourceforge.net/patchanim/?rev=84&view=rev
Author: dbrosius
Date: 2008-02-01 00:18:46 -0800 (Fri, 01 Feb 2008)
Log Message:
-----------
javadoc
Modified Paths:
--------------
trunk/patchanim/src/com/mebigfatguy/patchanim/OutOfBoundsColor.java
Modified: trunk/patchanim/src/com/mebigfatguy/patchanim/OutOfBoundsColor.java
===================================================================
--- trunk/patchanim/src/com/mebigfatguy/patchanim/OutOfBoundsColor.java 2008-02-01 08:14:28 UTC (rev 83)
+++ trunk/patchanim/src/com/mebigfatguy/patchanim/OutOfBoundsColor.java 2008-02-01 08:18:46 UTC (rev 84)
@@ -22,10 +22,21 @@
import com.mebigfatguy.patchanim.main.PatchAnimBundle;
+/**
+ * denotes how to render colors when they are outside the range of 0 - 255
+ * <ul>
+ * <li><b>Clip</b> Clip high values to 255, and low values to 0</li>
+ * <li><b>Roll</b> Use the remainder from the color value and 255 to calculate a value</li>
+ * </ul>
+ */
public enum OutOfBoundsColor {
Clip,
Roll;
+ /**
+ * returns the localized value of the enum
+ * @return the localized display value
+ */
@Override
public String toString() {
ResourceBundle rb = PatchAnimBundle.getBundle();
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
