X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FHistoryItem.java;h=eb4979d6c8ba2d8ea978cb2596fa3fcc016c2c4f;hb=32ccffc95209f230faacf6f27394669c0dc8b271;hp=ed119e8d8c649eb6e0dbf1c950e81c955bbd2f7d;hpb=588042b69abf8e60bcc950b24c283933c7dd422f;p=jalview.git

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