changeset 6422:316b45fa86bc

Added usage to javadoc for BreakpointNode
author Doug Simon <doug.simon@oracle.com>
date Thu, 20 Sep 2012 17:09:53 +0200
parents d855dd01629f
children 13a08f5bb120
files graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/BreakpointNode.java
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/BreakpointNode.java	Wed Sep 19 12:12:00 2012 +0200
+++ b/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/BreakpointNode.java	Thu Sep 20 17:09:53 2012 +0200
@@ -32,6 +32,17 @@
  * interest in the Java ABI specified parameter locations corresponding to the
  * kinds of the values. That is, the arguments are set up as if the breakpoint instruction
  * was a call to a compiled Java method.
+ * <p>
+ * A breakpoint is usually place by defining a node intrinsic method as follows:
+ * <pre>
+ *     {@literal @}NodeIntrinsic(BreakpointNode.class)
+ *     static void breakpoint(Object object, Word mark, Word value) {
+ *          throw new GraalInternalError("");
+ *     }
+ * </pre>
+ *
+ * Note that the signature is arbitrary. It's sole purpose is to capture values you
+ * may want to inspect in the native debugger when the breakpoint is hit.
  */
 public final class BreakpointNode extends FixedWithNextNode implements LIRLowerable {