Clarify executeJs JavaDocs for return values (#6815)

Fixes #6791 (cherry picked from commit feb1648)
vaadin · Nov 7, 2019 · 1764bca · 1764bca
1 parent d91678e
commit 1764bca
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/flow-server/src/main/java/com/vaadin/flow/component/page/Page.java b/flow-server/src/main/java/com/vaadin/flow/component/page/Page.java
@@ -414,9 +414,9 @@ public ExecutionCanceler executeJavaScript(String expression,
     /**
      * Asynchronously runs the given JavaScript expression in the browser.
      * <p>
-     * It is possible to get access to the return value of the execution by
-     * registering a handler with the returned pending result. If no handler is
-     * registered, the return value will be ignored.
+     * The returned <code>PendingJavaScriptResult</code> can be used to retrieve
+     * any <code>return</code> value from the JavaScript expression. If no
+     * return value handler is registered, the return value will be ignored.
      * <p>
      * The given parameters will be available to the expression as variables
      * named <code>$0</code>, <code>$1</code>, and so on. Supported parameter

diff --git a/flow-server/src/main/java/com/vaadin/flow/dom/Element.java b/flow-server/src/main/java/com/vaadin/flow/dom/Element.java
@@ -1669,9 +1669,10 @@ public void executeJavaScript(String expression,
     // When updating JavaDocs here, keep in sync with Page.executeJavaScript
     /**
      * Asynchronously runs the given JavaScript expression in the browser in the
-     * context of this element. It is possible to get access to the return value
-     * of the execution by registering a handler with the returned pending
-     * result. If no handler is registered, the return value will be ignored.
+     * context of this element. The returned
+     * <code>PendingJavaScriptResult</code> can be used to retrieve any
+     * <code>return</code> value from the JavaScript expression. If no return
+     * value handler is registered, the return value will be ignored.
      * <p>
      * This element will be available to the expression as <code>this</code>.
      * The given parameters will be available as variables named