# HG changeset patch
# User Doug Simon <doug.simon@oracle.com>
# Date 1348153793 -7200
# Node ID 316b45fa86bc3f355b6d3c7600c6d1fedcefbba8
# Parent  d855dd01629f423979d9363d5b2ece84a6bcdc5c
Added usage to javadoc for BreakpointNode

diff -r d855dd01629f -r 316b45fa86bc graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/BreakpointNode.java
--- 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 {