From: Jim Procter <jprocter@issues.jalview.org>
Date: Thu, 27 Apr 2017 15:25:24 +0000 (+0100)
Subject: JAL-2494 javadoc for AnnotatedCollectionI.findAnnotations
X-Git-Tag: Release_2_10_2~3^2~123^2~8
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=57ac5900f8f2d031f09ca563d3406283aa8a0d58;p=jalview.git

JAL-2494 javadoc for AnnotatedCollectionI.findAnnotations
---

diff --git a/src/jalview/datamodel/Alignment.java b/src/jalview/datamodel/Alignment.java
index 2dafc0c..17dfb4c 100755
--- a/src/jalview/datamodel/Alignment.java
+++ b/src/jalview/datamodel/Alignment.java
@@ -1635,10 +1635,6 @@ public class Alignment implements AlignmentI
     return aa;
   }
 
-  /**
-   * Returns an iterable collection of any annotations that match on given
-   * sequence ref, calcId and label (ignoring null values).
-   */
   @Override
   public Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
           String calcId, String label)
diff --git a/src/jalview/datamodel/AnnotatedCollectionI.java b/src/jalview/datamodel/AnnotatedCollectionI.java
index 3f6c515..2963fd5 100644
--- a/src/jalview/datamodel/AnnotatedCollectionI.java
+++ b/src/jalview/datamodel/AnnotatedCollectionI.java
@@ -40,6 +40,17 @@ public interface AnnotatedCollectionI extends SequenceCollectionI
    */
   Iterable<AlignmentAnnotation> findAnnotation(String calcId);
 
+  /**
+   * Returns an iterable collection of any annotations that match on given
+   * sequence ref, calcId and label (ignoring null values).
+   * 
+   * @param seq
+   *          null or reference sequence to select annotation for
+   * @param calcId
+   *          null or the calcId to select annotation for
+   * @param label
+   *          null or the label to select annotation for
+   */
   Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
           String calcId, String label);