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

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

Revision: 169
          http://polycasso.svn.sourceforge.net/polycasso/?rev=169&view=rev
Author:   dbrosius
Date:     2009-12-10 04:11:12 +0000 (Thu, 10 Dec 2009)

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

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

Modified: trunk/polycasso/src/com/mebigfatguy/polycasso/Saver.java
===================================================================
--- trunk/polycasso/src/com/mebigfatguy/polycasso/Saver.java	2009-12-10 04:09:58 UTC (rev 168)
+++ trunk/polycasso/src/com/mebigfatguy/polycasso/Saver.java	2009-12-10 04:11:12 UTC (rev 169)
@@ -21,7 +21,17 @@
 import java.awt.Dimension;
 import java.io.IOException;
 
+/**
+ * describes how the polygon data is to be save to a file in any one of a number of formats
+ */
 public interface Saver {
 	
+	/**
+	 * saves the set of polygons to some file
+	 *  
+	 * @param fileName the name of the file to write to
+	 * @param imageSize the dimension of the image
+	 * @param data the polygons to draw
+	 */
 	void save(String fileName, Dimension imageSize, PolygonData[] data) throws IOException;
 }


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