From 9b019f87ef82d834d31c815a152bded38858a610 Mon Sep 17 00:00:00 2001
From: Mick Jordan <mick.jordan@oracle.com>
Date: Thu, 19 Jun 2014 05:07:43 -0700
Subject: [PATCH] javadoc fixes

---
 .../src/com/oracle/truffle/r/engine/REngine.java      |  9 +++++++++
 .../src/com/oracle/truffle/r/runtime/RContext.java    | 11 +++--------
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/REngine.java b/com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/REngine.java
index 060819bdc0..c5bcf37bf1 100644
--- a/com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/REngine.java
+++ b/com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/REngine.java
@@ -161,6 +161,15 @@ public final class REngine implements RContext.Engine {
         return result;
     }
 
+    /**
+     * This is tricky because the {@link Frame} "f" associated with {@code envir} has been
+     * materialized so we can't evaluate in it directly. Instead we create a new
+     * {@link VirtualFrame}, that is a logical clone of "f", evaluate in that, and then update "f"
+     * on return.
+     *
+     * @param function the actual function that invoked the "eval", e.g. {@code eval}, {@code evalq}
+     *            , {@code local}.
+     */
     public Object eval(RFunction function, RLanguage expr, REnvironment envir, REnvironment enclos) throws PutException {
         RootCallTarget callTarget = makeCallTarget((RNode) expr.getRep(), REnvironment.globalEnv());
         MaterializedFrame envFrame = envir.getFrame();
diff --git a/com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RContext.java b/com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RContext.java
index 465f822a28..395daa1647 100644
--- a/com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RContext.java
+++ b/com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RContext.java
@@ -154,7 +154,7 @@ public final class RContext extends ExecutionContext {
         Object parseAndEvalTest(String rscript, boolean printResult);
 
         /**
-         * Support for the {@code eval} builtin using an {@link RExpression}.
+         * Evaluate an {@link RExpression} in a given environment {@code envir}.
          *
          * @param function identifies the eval variant, e.g. {@code local}, {@code eval},
          *            {@code evalq} being invoked.
@@ -162,13 +162,8 @@ public final class RContext extends ExecutionContext {
         Object eval(RFunction function, RExpression expr, REnvironment envir, REnvironment enclos) throws PutException;
 
         /**
-         * Support for the {@code eval} builtin. This is tricky because the {@link Frame} "f"
-         * associated with {@code envir} has been materialized so we can't evaluate in it directly.
-         * Instead we create a new {@link VirtualFrame}, that is a logical clone of "f", evaluate in
-         * that, and then update "f" on return.
-         *
-         * @param function the actual function that invoked the "eval", e.g. {@code eval},
-         *            {@code evalq} , {@code local}.
+         * Similar to {@link #eval(RFunction, RExpression, REnvironment, REnvironment)} but for a
+         * single langugge element.
          */
         Object eval(RFunction function, RLanguage expr, REnvironment envir, REnvironment enclos) throws PutException;
 
-- 
GitLab