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

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

Revision: 132
          http://pixelle.svn.sourceforge.net/pixelle/?rev=132&view=rev
Author:   dbrosius
Date:     2008-07-04 11:08:16 -0700 (Fri, 04 Jul 2008)

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

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

Modified: trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleEvalFactory.java
===================================================================
--- trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleEvalFactory.java	2008-07-04 15:27:48 UTC (rev 131)
+++ trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleEvalFactory.java	2008-07-04 18:08:16 UTC (rev 132)
@@ -24,6 +24,10 @@
 import com.mebigfatguy.pixelle.eval.PixelleEval4ByteABGR;
 import com.mebigfatguy.pixelle.eval.PixelleEvalByteGray;
 
+/**
+ * factory for creating pixel evaluation instances based on the type of image that is
+ * input.
+ */
 public class PixelleEvalFactory {
 
 	private static IndexOutOfBoundsOption ioobOption = IndexOutOfBoundsOption.BorderColor;
@@ -48,6 +52,13 @@
 		coobOption = option;
 	}
 	
+	/**
+	 * factory method for creating an pixel evaluator for the type of image that is
+	 * passed in.
+	 * 
+	 * @param image the image that will need to be evaluated
+	 * @return the pixel evaluator
+	 */
 	public static PixelleEval create(PixelleImage image) {
 		
 		switch (image.getType()) {


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