JAL-2360 Javadoc and test cases for findAnnotation

[jalview.git] / src / jalview / datamodel / AnnotatedCollectionI.java

diff --git a/src/jalview/datamodel/AnnotatedCollectionI.java b/src/jalview/datamodel/AnnotatedCollectionI.java
index 6814b7e..3f6c515 100644 (file)
--- a/src/jalview/datamodel/AnnotatedCollectionI.java
+++ b/src/jalview/datamodel/AnnotatedCollectionI.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -31,6 +31,13 @@ public interface AnnotatedCollectionI extends SequenceCollectionI
    */
   AlignmentAnnotation[] getAlignmentAnnotation();
 
+  /**
+   * Returns a list of annotations matching the given calc id, or an empty list
+   * if calcId is null
+   * 
+   * @param calcId
+   * @return
+   */
   Iterable<AlignmentAnnotation> findAnnotation(String calcId);
 
   Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,