JAL-2805 finished up interface comments

[jalview.git] / src / jalview / ext / archaeopteryx / ExternalTreeBuilderI.java

diff --git a/src/jalview/ext/archaeopteryx/ExternalTreeBuilderI.java b/src/jalview/ext/archaeopteryx/ExternalTreeBuilderI.java
index f27117d..17ae7f8 100644 (file)
--- a/src/jalview/ext/archaeopteryx/ExternalTreeBuilderI.java
+++ b/src/jalview/ext/archaeopteryx/ExternalTreeBuilderI.java
@@ -4,6 +4,18 @@ import jalview.datamodel.SequenceI;
 
 import java.util.Map;
 
+/**
+ * Note that this will take anything as a Tree or TreeNode object as no
+ * assumptions can be made about the inheritance structure of Tree or TreeNode
+ * (besides being Objects).
+ * 
+ * @author kjvanderheide
+ *
+ * @param <T>
+ *          Tree object that the tree viewer requires.
+ * @param <N>
+ *          Tree node object that the tree viewer requires.
+ */
 interface ExternalTreeBuilderI<T, N>
 {
   public T buildTree(N treeRoot);