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

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

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

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

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

Modified: trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedListener.java
===================================================================
--- trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedListener.java	2009-11-24 05:16:35 UTC (rev 29)
+++ trunk/polycasso/src/com/mebigfatguy/polycasso/ImageGeneratedListener.java	2009-11-24 05:18:38 UTC (rev 30)
@@ -18,7 +18,17 @@
  */
 package com.mebigfatguy.polycasso;
 
+/**
+ * an interface that interested parties should implement if they wish to be
+ * informed when a new best image has been found.
+ */
 public interface ImageGeneratedListener {
 
+	/**
+	 * a method to be implement that will give the interested party what image
+	 * is now considered to be the best
+	 * 
+	 * @param event the event object describing the new best image
+	 */
 	public void imageGenerated(ImageGeneratedEvent event);
 }


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