changeset 21117:f6f3f44a1830

Truffle/Instrumentation: Javadoc corrections on Node.{getSourceSection,getEncapsulatingSourceSection}
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sat, 25 Apr 2015 19:47:45 -0700
parents bf8cbbfabdcf
children ae4941602cfa fc6fd02ecf95
files graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java
diffstat 1 files changed, 6 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java	Fri Apr 24 12:05:38 2015 -0700
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/Node.java	Sat Apr 25 19:47:45 2015 -0700
@@ -118,18 +118,20 @@
     }
 
     /**
-     * Retrieves the guest language source code section that is currently assigned to this node.
+     * Retrieves the segment of guest language source code that is represented by this Node.
      *
-     * @return the assigned source code section
+     * @return the source code represented by this Node
      */
     public final SourceSection getSourceSection() {
         return sourceSection;
     }
 
     /**
-     * Retrieves the guest language source code section that is currently assigned to this node.
+     * Retrieves the segment of guest language source code that is represented by this Node, if
+     * present; otherwise retrieves the segment represented by the nearest AST ancestor that has
+     * this information.
      *
-     * @return the assigned source code section
+     * @return an approximation of the source code represented by this Node
      */
     @ExplodeLoop
     public final SourceSection getEncapsulatingSourceSection() {