JAL-966 clarify javadoc for SearchResultsI.getResults

diff --git a/src/jalview/datamodel/SearchResultsI.java b/src/jalview/datamodel/SearchResultsI.java
index f7d3468..dc18bb8 100644 (file)
--- a/src/jalview/datamodel/SearchResultsI.java
+++ b/src/jalview/datamodel/SearchResultsI.java
@@ -32,8 +32,16 @@ public interface SearchResultsI
 
   /**
    * This Method returns the search matches which lie between the start and end
-   * points of the sequence in question. It is optimised for returning objects
+   * points of the sequence in question . It is optimised for returning objects
    * for drawing on SequenceCanvas
+   * 
+   * @param sequence
+   *          sequence to highlight columns according to matches
+   * @param start
+   *          - first column of visible region
+   * @param end
+   *          - last column of visible region
+   * @return int[] ranges within start/end index on sequence
    */
   public abstract int[] getResults(SequenceI sequence, int start, int end);