[Pixelle-commit] SF.net SVN: pixelle: [69] trunk/pixelle/src/com/mebigfatguy/pixelle/ OutOfBoundsOption.java

[<dbr...@us...>]

Revision: 69
          http://pixelle.svn.sourceforge.net/pixelle/?rev=69&view=rev
Author:   dbrosius
Date:     2008-06-24 19:46:15 -0700 (Tue, 24 Jun 2008)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    trunk/pixelle/src/com/mebigfatguy/pixelle/OutOfBoundsOption.java

Modified: trunk/pixelle/src/com/mebigfatguy/pixelle/OutOfBoundsOption.java
===================================================================
--- trunk/pixelle/src/com/mebigfatguy/pixelle/OutOfBoundsOption.java	2008-06-25 02:43:28 UTC (rev 68)
+++ trunk/pixelle/src/com/mebigfatguy/pixelle/OutOfBoundsOption.java	2008-06-25 02:46:15 UTC (rev 69)
@@ -20,17 +20,34 @@
 
 import java.awt.Color;
 
+/**
+ * an enum that represents what to do when an index specified is outside the coordinates
+ * of the source bitmap.
+ */
 public enum OutOfBoundsOption {
+	/** use the specified color */
 	SpecifiedColor,
+	/** use the closest border color */
 	BorderColor,
+	/** calculate a new index using the modulus function of the width or height */
 	WrapColor;
 	
 	private Color color = Color.WHITE;
 
+	/**
+	 * retrieves the color that is used for when the enum is 'SpecifiedColor'
+	 * 
+	 * @return the specified color
+	 */
 	public Color getColor() {
 		return color;
 	}
 
+	/**
+	 * sets the color that is used for when the enum is 'SpecifiedColor'
+	 * 
+	 * @param the specified color
+	 */
 	public void setColor(Color clr) {
 		color = clr;
 	}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.