diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java @ 19038:c7e57dffc5ad

Truffle/Instrumentation: comments and minor code cleanup post-review
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Thu, 29 Jan 2015 11:44:14 -0800
parents 867058575979
children 67d9e635102f
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java	Thu Jan 29 11:27:19 2015 +0100
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java	Thu Jan 29 11:44:14 2015 -0800
@@ -437,6 +437,9 @@
      * that intercepts execution events at the node and routes them to any {@link Instrument}s that
      * have been attached to the {@link Probe}. Only one {@link Probe} may be installed at each
      * node; subsequent calls return the one already installed.
+     * <p>
+     * <b>Note:</b> instrumentation requires a appropriate {@link WrapperNode}, which must be
+     * provided by {@link #createWrapperNode()}.
      *
      * @see Instrument
      */
@@ -449,7 +452,7 @@
      * <ol>
      * <li>implements {@link WrapperNode}</li>
      * <li>has {@code this} as it's child, and</li>
-     * <li>whose type is suitable for (unsafe) replacement of {@code this} in the parent.</li>
+     * <li>whose type is safe for replacement of {@code this} in the parent.</li>
      * </ol>
      *
      * @return an appropriately typed {@link WrapperNode} if {@link #isInstrumentable()}.