changeset 5258:97b1e0ab7442

added javadoc to some of the API for removing nodes from a graph
author Doug Simon <doug.simon@oracle.com>
date Fri, 20 Apr 2012 14:12:42 +0200
parents a549662f6c6f
children af8958fe5a3a
files graal/com.oracle.graal.graph/src/com/oracle/graal/graph/Node.java graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/StructuredGraph.java
diffstat 2 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.graph/src/com/oracle/graal/graph/Node.java	Fri Apr 20 14:10:57 2012 +0200
+++ b/graal/com.oracle.graal.graph/src/com/oracle/graal/graph/Node.java	Fri Apr 20 14:12:42 2012 +0200
@@ -332,6 +332,10 @@
         return true;
     }
 
+    /**
+     * Removes this node from its graph.
+     * This node must have no {@linkplain Node#usages() usages} and no {@linkplain #predecessor() predecessor}.
+     */
     public void safeDelete() {
         assert checkDeletion();
         clearInputs();
--- a/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/StructuredGraph.java	Fri Apr 20 14:10:57 2012 +0200
+++ b/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/StructuredGraph.java	Fri Apr 20 14:12:42 2012 +0200
@@ -166,6 +166,12 @@
         node.safeDelete();
     }
 
+    /**
+     * Unlinks a node from all its control flow neighbours and then removes it from its graph.
+     * The node must have no {@linkplain Node#usages() usages}.
+     *
+     * @param node the node to be unlinked and removed
+     */
     public void removeFixed(FixedWithNextNode node) {
         assert node != null;
         if (node instanceof BeginNode) {