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

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

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

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

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

Modified: trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedEvent.java
===================================================================
--- trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedEvent.java	2009-11-24 05:14:47 UTC (rev 28)
+++ trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedEvent.java	2009-11-24 05:16:35 UTC (rev 29)
@@ -21,16 +21,32 @@
 import java.awt.Image;
 import java.util.EventObject;
 
+/**
+ * an event object that is fired when a new test image has been found that is 
+ * the best so far.
+ */
 public class ImageGeneratedEvent extends EventObject {
 
 	private static final long serialVersionUID = 1478846574394938989L;
 	private Image bestImage;
 	
+	/**
+	 * creates the event object with the source of the event as well as the image
+	 * that is now the best image found.
+	 * 
+	 * @param source the object that generated this event (an image generator)
+	 * @param image the best image found so far
+	 */
 	public ImageGeneratedEvent(Object source, Image image) {
 		super(source);
 		bestImage = image;
 	}
 	
+	/**
+	 * retrieve the best image as described by this event
+	 * 
+	 * @return the best image
+	 */
 	public Image getImage() {
 		return bestImage;
 	}


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