From ac7571ed0fd171c2a68c3db71f2635bd6cb8777e Mon Sep 17 00:00:00 2001 From: Jim Procter Date: Sun, 30 Oct 2016 12:54:59 +0000 Subject: [PATCH] JAL-966 clarify javadoc for SearchResultsI.getResults --- src/jalview/datamodel/SearchResultsI.java | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) 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); -- 1.7.10.2