diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/InstrumentationNode.java @ 20887:37912559d662

Truffle/Instrumentation: Javadoc work on instrument listener interfaces.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Fri, 10 Apr 2015 17:55:09 -0700
parents 907128d02b31
children
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/InstrumentationNode.java	Fri Apr 10 16:58:26 2015 -0700
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/InstrumentationNode.java	Fri Apr 10 17:55:09 2015 -0700
@@ -28,8 +28,9 @@
 import com.oracle.truffle.api.nodes.*;
 
 /**
- * A marker interface for Truffle {@linkplain Node nodes} that support <em>Instrumentation</em> and
- * are should not be part of any Guest Language execution semantics.
+ * A marker interface for Truffle {@linkplain Node nodes} that internally implement the
+ * <em>Instrumentation Framework</em>. Such nodes should not be part of any Guest Language execution
+ * semantics, and should in general not be visible to ordinary Instrumentation clients.
  */
 public interface InstrumentationNode {
 
@@ -39,7 +40,8 @@
     String instrumentationInfo();
 
     /**
-     * Events at a Truffle node that get propagated through the Instrumentation Framework.
+     * Events that propagate through the {@linkplain InstrumentationNode implementation nodes} of
+     * the Instrumentation Framework, not visible in this form to Instrumentation clients.
      */
     interface TruffleEvents {
 
@@ -62,6 +64,5 @@
          * An AST Node's execute method has just thrown an exception.
          */
         void returnExceptional(Node node, VirtualFrame vFrame, Exception exception);
-
     }
 }