javadoc
authorjprocter <Jim Procter>
Mon, 30 Jul 2007 17:01:20 +0000 (17:01 +0000)
committerjprocter <Jim Procter>
Mon, 30 Jul 2007 17:01:20 +0000 (17:01 +0000)
src/jalview/datamodel/Sequence.java

index 16ba407..0e72690 100755 (executable)
@@ -24,7 +24,8 @@ import java.util.*;
 import jalview.analysis.*;
 
 /**
- * DOCUMENT ME!
+ * 
+ * Implements the SequenceI interface for a char[] based sequence object.
  *
  * @author $author$
  * @version $Revision$
@@ -46,17 +47,17 @@ public class Sequence
    * positions are tied to the residues of this sequence */
   Vector annotation;
 
-  /** DOCUMENT ME!! */
+  /** array of seuqence features - may not be null for a valid sequence object */
   public SequenceFeature[] sequenceFeatures;
 
 
   /**
    * Creates a new Sequence object.
    *
-   * @param name DOCUMENT ME!
-   * @param sequence DOCUMENT ME!
-   * @param start DOCUMENT ME!
-   * @param end DOCUMENT ME!
+   * @param name display name string
+   * @param sequence string to form a possibly gapped sequence out of
+   * @param start first position of non-gap residue in the sequence
+   * @param end last position of ungapped residues (nearly always only used for display purposes)
    */
   public Sequence(String name, String sequence, int start, int end)
   {