Formatting changes

[jalview.git] / src / jalview / datamodel / HistoryItem.java

diff --git a/src/jalview/datamodel/HistoryItem.java b/src/jalview/datamodel/HistoryItem.java
index ed119e8..eb4979d 100755 (executable)
--- a/src/jalview/datamodel/HistoryItem.java
+++ b/src/jalview/datamodel/HistoryItem.java
@@ -21,10 +21,24 @@ package jalview.datamodel;
 import java.util.*;\r
 \r
 \r
-public class HistoryItem {\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class HistoryItem\r
+{\r
+    /** DOCUMENT ME!! */\r
     public static final int EDIT = 0;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int SORT = 1;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int HIDE = 2;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int PASTE = 3;\r
     final int type;\r
     Vector sequences;\r
@@ -32,14 +46,23 @@ public class HistoryItem {
     String description;\r
     Vector hiddenSeqs;\r
 \r
-    public HistoryItem(String description, AlignmentI al, int type) {\r
+    /**\r
+     * Creates a new HistoryItem object.\r
+     *\r
+     * @param description DOCUMENT ME!\r
+     * @param al DOCUMENT ME!\r
+     * @param type DOCUMENT ME!\r
+     */\r
+    public HistoryItem(String description, AlignmentI al, int type)\r
+    {\r
         this.type = type;\r
         this.description = description;\r
         sequences = new Vector();\r
         alignIndex = new Vector();\r
         hiddenSeqs = new Vector();\r
 \r
-        for (int i = 0; i < al.getHeight(); i++) {\r
+        for (int i = 0; i < al.getHeight(); i++)\r
+        {\r
             SequenceI seq = al.getSequenceAt(i);\r
             sequences.addElement(seq);\r
             alignIndex.addElement(i + "");\r
@@ -47,23 +70,55 @@ public class HistoryItem {
         }\r
     }\r
 \r
-    public int getType() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getType()\r
+    {\r
         return type;\r
     }\r
 \r
-    public Vector getSequences() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public Vector getSequences()\r
+    {\r
         return sequences;\r
     }\r
 \r
-    public String getDescription() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getDescription()\r
+    {\r
         return description;\r
     }\r
 \r
-    public Vector getHidden() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public Vector getHidden()\r
+    {\r
         return hiddenSeqs;\r
     }\r
 \r
-    public int getAlignIndex(int seq) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param seq DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getAlignIndex(int seq)\r
+    {\r
         return Integer.parseInt(alignIndex.elementAt(seq).toString());\r
     }\r
 }\r