From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Tue, 28 Aug 2012 09:46:44 +0000 (+0100)
Subject: javadoc and note about broken semantics for findIndex
X-Git-Tag: Jalview_2_9~392
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=8666783ae3a3072f6c095c0f4d5037d4452afeb2;p=jalview.git

javadoc and note about broken semantics for findIndex
---

diff --git a/src/jalview/datamodel/Sequence.java b/src/jalview/datamodel/Sequence.java
index 293528d..21b877d 100755
--- a/src/jalview/datamodel/Sequence.java
+++ b/src/jalview/datamodel/Sequence.java
@@ -577,13 +577,9 @@ public class Sequence implements SequenceI
     return this.description;
   }
 
-  /**
-   * Return the alignment position for a sequence position
-   * 
-   * @param pos
-   *          lying from start to end
-   * 
-   * @return aligned position of residue pos
+  
+  /* (non-Javadoc)
+   * @see jalview.datamodel.SequenceI#findIndex(int)
    */
   public int findIndex(int pos)
   {
diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 33045d0..186156d 100755
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -164,12 +164,15 @@ public interface SequenceI
   public String getDescription();
 
   /**
-   * DOCUMENT ME!
+   * Return the alignment column for a sequence position
+   *    * Return the alignment position for a sequence position
    * 
    * @param pos
-   *          DOCUMENT ME!
+   *          lying from start to end
+   * 
+   * @return aligned column for residue (0 if residue is upstream from alignment, -1 if residue is downstream from alignment)
+   * note. Sequence object returns sequence.getEnd() for positions upstream currently. TODO: change sequence for assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
    * 
-   * @return DOCUMENT ME!
    */
   public int findIndex(int pos);