# HG changeset patch
# User Gilles Duboscq <duboscq@ssw.jku.at>
# Date 1415796527 -3600
# Node ID f7a98bf171854f5dab281330942e6e01e8c7c244
# Parent  05fde207f06ca92fcc424a5d0e8942abf4d3b7ce
Add some javadoc to MergeableState

diff -r 05fde207f06c -r f7a98bf17185 graal/com.oracle.graal.phases/src/com/oracle/graal/phases/graph/MergeableState.java
--- a/graal/com.oracle.graal.phases/src/com/oracle/graal/phases/graph/MergeableState.java	Wed Nov 12 13:35:47 2014 +0100
+++ b/graal/com.oracle.graal.phases/src/com/oracle/graal/phases/graph/MergeableState.java	Wed Nov 12 13:48:47 2014 +0100
@@ -31,11 +31,18 @@
     @Override
     public abstract T clone();
 
+    /**
+     * This method is called on merge on the state of the first branch. The {@code withStates} list
+     * contains the states of the of the other branches in the order of the merge's end nodes.
+     *
+     * @param merge the merge node
+     * @param withStates the state at the the merge's end node except the first one.
+     */
     public abstract boolean merge(MergeNode merge, List<T> withStates);
 
     /**
      * This method is called before a loop is entered (before the {@link LoopBeginNode} is visited).
-     * 
+     *
      * @param loopBegin the begin node of the loop
      */
     public void loopBegin(LoopBeginNode loopBegin) {
@@ -44,7 +51,7 @@
 
     /**
      * This method is called after all {@link LoopEndNode}s belonging to a loop have been visited.
-     * 
+     *
      * @param loopBegin the begin node of the loop
      * @param loopEndStates the states at the loop ends, sorted according to
      *            {@link LoopBeginNode#orderedLoopEnds()}
@@ -55,7 +62,7 @@
 
     /**
      * This method is called before the successors of a {@link ControlSplitNode} are visited.
-     * 
+     *
      * @param node the successor of the control split that is about to be visited
      */
     public void afterSplit(BeginNode node) {