From: Jim Procter Date: Sun, 30 Oct 2016 12:54:59 +0000 (+0000) Subject: JAL-966 clarify javadoc for SearchResultsI.getResults X-Git-Tag: Release_2_10_1~10^2~6^2~1^2~21 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=ac7571ed0fd171c2a68c3db71f2635bd6cb8777e;p=jalview.git 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 --- 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);