JAL-1953 more javadoc comments

[jalview.git] / src / jalview / ext / treeviewer / TreeI.java

diff --git a/src/jalview/ext/treeviewer/TreeI.java b/src/jalview/ext/treeviewer/TreeI.java
index fbda8f1..08c3d04 100644 (file)
--- a/src/jalview/ext/treeviewer/TreeI.java
+++ b/src/jalview/ext/treeviewer/TreeI.java
@@ -8,8 +8,7 @@ import java.util.Iterator;
 import java.util.List;
 
 /**
- * Interface for a generic phylogenetic tree, this does not necessarily have to
- * be part of a tree panel.
+ * Interface for implementing a phylogenetic tree.
  * 
  * @author kjvanderheide
  *
@@ -29,9 +28,23 @@ public interface TreeI
 
   public TreeNodeI[] getAllNodes();
 
+  /**
+   * Gets the node that has the maximum branch length from the root (or top
+   * level node if tree is unrooted).
+   * 
+   * @return
+   */
   public TreeNodeI getFurthestNode();
 
-  public double getHeight(boolean adjustForCollapsedSubtrees);
+  /**
+   * Returns the longest total branch length from the root to a leaf node.
+   * 
+   * @param adjustForCollapsedSubtrees
+   *          true if nodes part of a collapsed (hidden) subtree should be
+   *          considered.
+   * @return
+   */
+  public double getMaximumLength(boolean adjustForCollapsedSubtrees);
 
   public List<SequenceI> getNodeSequences();