From: gmungoc <g.m.carstairs@dundee.ac.uk>
Date: Fri, 10 Nov 2017 15:38:19 +0000 (+0000)
Subject: JAL-2562 updated findPosition javadoc to match behaviour
X-Git-Tag: Release_2_10_3b1~30^2~1
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=40f53cf86e7d8c2a89f23b66024d46633307c83a;p=jalview.git

JAL-2562 updated findPosition javadoc to match behaviour
---

diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 6e6d1aa..857f206 100755
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -192,13 +192,14 @@ public interface SequenceI extends ASequenceI
   public int findIndex(int pos);
 
   /**
-   * Returns the sequence position for an alignment position.
+   * Returns the sequence position for an alignment (column) position. If at a
+   * gap, returns the position of the next residue to the right. If beyond the
+   * end of the sequence, returns 1 more than the last residue position.
    * 
    * @param i
    *          column index in alignment (from 0..<length)
    * 
-   * @return TODO: JAL-2562 - residue number for residue (left of and) nearest
-   *         ith column
+   * @return
    */
   public int findPosition(int i);