JAL-1953 first pass of adding javadoc, some methods renamed

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

diff --git a/src/jalview/ext/treeviewer/TreeControlsI.java b/src/jalview/ext/treeviewer/TreeControlsI.java
index 9a209e7..d33c73b 100644 (file)
--- a/src/jalview/ext/treeviewer/TreeControlsI.java
+++ b/src/jalview/ext/treeviewer/TreeControlsI.java
@@ -1,9 +1,18 @@
 package jalview.ext.treeviewer;
 
+/**
+ * Interface for visually manipulating the tree with methods that might be user
+ * triggered.
+ * 
+ * @author kjvanderheide
+ *
+ */
 public interface TreeControlsI
 {
-  public void defaultSettings();
-
+  /**
+   * Resets the current view so that it shows the tree in its entirety (in case
+   * it was previously zoomed in etc.)
+   */
   public void displayEntireTree();
 
 }