# HG changeset patch
# User Lukas Stadler <lukas.stadler@jku.at>
# Date 1361884605 -3600
# Node ID 7c251679c07f18be5fcf0f47b56c102114b7cb50
# Parent  b66a826acf4bb291bccdee9704cef608e2d847bc
javadoc for MemoryCheckpoint

diff -r b66a826acf4b -r 7c251679c07f graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/extended/MemoryCheckpoint.java
--- a/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/extended/MemoryCheckpoint.java	Wed Feb 13 15:52:26 2013 +0100
+++ b/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/extended/MemoryCheckpoint.java	Tue Feb 26 14:16:45 2013 +0100
@@ -22,8 +22,21 @@
  */
 package com.oracle.graal.nodes.extended;
 
+import com.oracle.graal.nodes.*;
+
+/**
+ * This interface marks is used for subclasses of {@link FixedNode} that kill a set of memory
+ * locations represented by a location identity (i.e. change a value at one or more locations that
+ * belong to this location identity).
+ */
 public interface MemoryCheckpoint {
 
+    /**
+     * This method is used to determine which set of memory locations is killed by this node.
+     * Returning the special value {@link LocationNode#ANY_LOCATION} will kill all memory locations.
+     * 
+     * @return the identity of the location killed by this node.
+     */
     Object getLocationIdentity();
 
 }