[Patchanim-commit] SF.net SVN: patchanim: [83] trunk/patchanim/src/com/mebigfatguy/patchanim

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

Revision: 83
          http://patchanim.svn.sourceforge.net/patchanim/?rev=83&view=rev
Author:   dbrosius
Date:     2008-02-01 00:14:28 -0800 (Fri, 01 Feb 2008)

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

Modified Paths:
--------------
    trunk/patchanim/src/com/mebigfatguy/patchanim/AnimationType.java
    trunk/patchanim/src/com/mebigfatguy/patchanim/ExportType.java

Modified: trunk/patchanim/src/com/mebigfatguy/patchanim/AnimationType.java
===================================================================
--- trunk/patchanim/src/com/mebigfatguy/patchanim/AnimationType.java	2008-02-01 08:02:15 UTC (rev 82)
+++ trunk/patchanim/src/com/mebigfatguy/patchanim/AnimationType.java	2008-02-01 08:14:28 UTC (rev 83)
@@ -22,11 +22,22 @@
 
 import com.mebigfatguy.patchanim.main.PatchAnimBundle;
 
+/**
+ * denotes the way animations progress through the series of images.
+ * <ul>
+ * 	<li><b>None</b> Animation progress from start to finish and then stops</li>
+ * 	<li><b>Cycle</b> Animation progress from start to finish and then from finish to start, and repeats</li>
+ * 	<li><b>None</b> Animation progress from start to finish and then repeats</li>
+ * </ul>
+ */
 public enum AnimationType {
 	None,
 	Cycle,
 	Wave;
 	
+	/**
+	 * returns the localized value of the type
+	 */
 	@Override
 	public String toString() {
 		ResourceBundle rb = PatchAnimBundle.getBundle();

Modified: trunk/patchanim/src/com/mebigfatguy/patchanim/ExportType.java
===================================================================
--- trunk/patchanim/src/com/mebigfatguy/patchanim/ExportType.java	2008-02-01 08:02:15 UTC (rev 82)
+++ trunk/patchanim/src/com/mebigfatguy/patchanim/ExportType.java	2008-02-01 08:14:28 UTC (rev 83)
@@ -2,6 +2,16 @@
 
 import com.mebigfatguy.patchanim.main.PatchAnimBundle;
 
+/**
+ * denotes the type of file to export to
+ * <ul>
+ *  <li><b>JPegs</b> a series of jpeg files in a directory</li>
+ *  <li><b>Pngs</b> a series of Png files in a directory</li>
+ *  <li><b>Gifs</b> a series of Gif files in a directory</li>
+ *  <li><b>AnimatedGif</b> an animated gif file</li>
+ *  <li><b>Mpeg</b> an animated mpeg file</li>
+ * </ul>
+ */
 public enum ExportType {
 	JPegs("jpg", true, PatchAnimBundle.JPGSERIESFILTER),
 	Pngs("png", true, PatchAnimBundle.PNGSERIESFILTER),
@@ -13,20 +23,38 @@
 	private boolean multi;
 	private String key;
 	
+	/**
+	 * constructs an ExportType enum
+	 * @param extension the file extension used for this type
+	 * @param multipleFiles whether or not this file type generates multiple files
+	 * @param descriptionKey the resource bundle key for the display value
+	 */
 	private ExportType(String extension, boolean multipleFiles, String descriptionKey) {
 		ext = extension;
 		multi = multipleFiles;
 		key = descriptionKey;
 	}
 	
+	/**
+	 * returns the file extension for this export type
+	 * @return the file extension
+	 */
 	public String getExtension() {
 		return ext;
 	}
 	
+	/**
+	 * returns whether or not this file type generates multiple files
+	 * @return whether the export generates multiple files
+	 */
 	public boolean isMultipleFiles() {
 		return multi;
 	}
 	
+	/**
+	 * returns the resource bundle key for the localized value
+	 * @return the resource key
+	 */
 	public String getDescriptionKey() {
 		return key;
 	}


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