[Polycasso-commit] SF.net SVN: polycasso:[32] trunk/polycasso/src/com/mebigfatguy/polycasso/ ImprovementType.java

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

Revision: 32
          http://polycasso.svn.sourceforge.net/polycasso/?rev=32&view=rev
Author:   dbrosius
Date:     2009-11-24 05:25:51 +0000 (Tue, 24 Nov 2009)

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

Modified Paths:
--------------
    trunk/polycasso/src/com/mebigfatguy/polycasso/ImprovementType.java

Modified: trunk/polycasso/src/com/mebigfatguy/polycasso/ImprovementType.java
===================================================================
--- trunk/polycasso/src/com/mebigfatguy/polycasso/ImprovementType.java	2009-11-24 05:24:31 UTC (rev 31)
+++ trunk/polycasso/src/com/mebigfatguy/polycasso/ImprovementType.java	2009-11-24 05:25:51 UTC (rev 32)
@@ -18,7 +18,10 @@
  */
 package com.mebigfatguy.polycasso;
 
-
+/**
+ * an enumeration of all the different improvement types that an ImageGenerator can attempt
+ * to make to an image.
+ */
 public enum ImprovementType { 
 	AddPoint, 
 	RemovePoint, 
@@ -30,6 +33,11 @@
 	ChangeAlpha, 
 	CompleteChange;
 	
+	/**
+	 * returns a improvement type at random to try on an image
+	 * 
+	 * @return an improvement type
+	 */
 	public static ImprovementType getRandomImprovement() {
 		ImprovementType[] types = ImprovementType.values();
 		return types[(int)((int)(Math.random() * types.length))];


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