javadoc updated

8 files changed, 45 insertions, 8 deletions

diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchPointFigure.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchPointFigure.java
index bc18afb255..dfcb00277e 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchPointFigure.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchPointFigure.java
@@ -12,6 +12,12 @@ package org.eclipse.emf.cdo.ui.internal.branch.figure;
 
 import org.eclipse.draw2d.ColorConstants;
 
+/**
+ * The Figure used to visualize a BranchPoint
+ * 
+ * @author Andre Dietisheim
+ * @see BranchPointNode.
+ */
 public class BranchPointFigure extends CommitInfoFigure
 {
   public BranchPointFigure(String text)
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchRootFigure.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchRootFigure.java
index d8723eb2ec..a62f6cd2c0 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchRootFigure.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/BranchRootFigure.java
@@ -10,8 +10,16 @@
  */
 package org.eclipse.emf.cdo.ui.internal.branch.figure;
 
+import org.eclipse.emf.cdo.ui.internal.branch.item.RootNode;
+
 import org.eclipse.draw2d.Figure;
 
+/**
+ * The Figure used to visualise the (single) root node of a BranchTree.
+ * 
+ * @author Andre Dietisheim
+ * @see RootNode
+ */
 public class BranchRootFigure extends Figure
 {
   public BranchRootFigure()
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/CommitInfoFigure.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/CommitInfoFigure.java
index 472b5e22d1..0743a6de28 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/CommitInfoFigure.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/figure/CommitInfoFigure.java
@@ -15,10 +15,21 @@ import org.eclipse.draw2d.Ellipse;
 import org.eclipse.draw2d.Label;
 import org.eclipse.swt.SWT;
 
+/**
+ * The Figure used to visualize a commit info node in the branch tree.
+ * 
+ * @author Andre Dietisheim
+ */
 public class CommitInfoFigure extends Ellipse
 {
   // private Label label;
 
+  /**
+   * Instantiates a new commit info figure.
+   * 
+   * @param text
+   *          the text
+   */
   public CommitInfoFigure(String text)
   {
     setAntialias(SWT.ON);
@@ -34,4 +45,3 @@ public class CommitInfoFigure extends Ellipse
     setToolTip(new Label(text));
   }
 }
-
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/geometry/GeometryUtils.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/geometry/GeometryUtils.java
index 1dcbba8653..b5e195da8d 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/geometry/GeometryUtils.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/geometry/GeometryUtils.java
@@ -13,6 +13,9 @@ package org.eclipse.emf.cdo.ui.internal.branch.geometry;
 import org.eclipse.zest.layouts.dataStructures.DisplayIndependentDimension;
 import org.eclipse.zest.layouts.dataStructures.DisplayIndependentRectangle;
 
+/**
+ * Holds various utiliy method that help to deal with gemoetry classes in zest .
+ */
 public class GeometryUtils
 {
   /**
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchPointNode.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchPointNode.java
index 4542e6be43..26fdc6175b 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchPointNode.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchPointNode.java
@@ -20,7 +20,12 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
+ * A node that holds a branch point. It may be connected to a further (single) BranchPointNode by a NewBranchConnection
+ * to a node in a sub-branch. It may also be connected to a node in the same branch by a SameBranchConnection.
+ * 
  * @author Andre Dietisheim
+ * @see SameBranchConnection
+ * @see NewBranchConnection
  */
 public class BranchPointNode extends AbstractBranchPointNode
 {
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchTreeUtils.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchTreeUtils.java
index 49f2b50746..9df9fa460e 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchTreeUtils.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/BranchTreeUtils.java
@@ -10,11 +10,10 @@
  */
 package org.eclipse.emf.cdo.ui.internal.branch.item;
 
-
 import org.eclipse.zest.layouts.dataStructures.InternalNode;
 
 /**
- * Various utility methods used by the branch graph
+ * Various utility methods that help to deal with the manipulations needed to build a BranchTree.
  * 
  * @author Andre Dietisheim
  */
@@ -73,7 +72,7 @@ public class BranchTreeUtils
   {
     InternalNode sourceInternalNode = getInternalNode(sourceNode);
     return sourceInternalNode.getInternalX()
-        + ((sourceInternalNode.getInternalWidth() - getInternalNode(targetNode).getInternalWidth()) / 2);
+        + (sourceInternalNode.getInternalWidth() - getInternalNode(targetNode).getInternalWidth()) / 2;
   }
 
   /**
@@ -138,7 +137,8 @@ public class BranchTreeUtils
    * @param y
    *          the y coordinate to apply
    */
-  public static void centerHorizontally(AbstractBranchPointNode nodeToBeCentered, AbstractBranchPointNode sourceNode, double y)
+  public static void centerHorizontally(AbstractBranchPointNode nodeToBeCentered, AbstractBranchPointNode sourceNode,
+      double y)
   {
     double x = getCenteredX(nodeToBeCentered, sourceNode);
     InternalNode internalNode = getInternalNode(nodeToBeCentered);
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/NewBranchConnection.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/NewBranchConnection.java
index d790054c94..bc7e57d0b5 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/NewBranchConnection.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/NewBranchConnection.java
@@ -11,7 +11,10 @@
 package org.eclipse.emf.cdo.ui.internal.branch.item;
 
 /**
- * A connection to a {@link BranchTreeNode} in a new (sub-)branch.
+ * Connects a BranchPoint node to another one. The second node have to be in another (sub-)branch, though.
+ * 
+ * @author Andre Dietisheim
+ * @see SameBranchConnection
  */
 import org.eclipse.zest.core.widgets.Graph;
 import org.eclipse.zest.core.widgets.GraphConnection;
diff --git a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/SameBranchConnection.java b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/SameBranchConnection.java
index 6bd34e426d..9b0677f8c1 100644
--- a/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/SameBranchConnection.java
+++ b/plugins/org.eclipse.emf.cdo.ui.branch/src/org/eclipse/emf/cdo/ui/internal/branch/item/SameBranchConnection.java
@@ -10,13 +10,15 @@
  */
 package org.eclipse.emf.cdo.ui.internal.branch.item;
 
-
 import org.eclipse.zest.core.widgets.Graph;
 import org.eclipse.zest.core.widgets.GraphConnection;
 import org.eclipse.zest.core.widgets.GraphNode;
 
 /**
- * A connection to a {@link AbstractBranchPointNode} in the same branch.
+ * Connects a BranchPointNode to another one in the same branch.
+ * 
+ * @author Andre Dietisheim
+ * @see NewBranchConnection
  */
 public class SameBranchConnection extends GraphConnection
 {