You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 10:11:23 UTC

[sling-org-apache-sling-scripting-sightly-js-provider] 07/24: trivial: corrected JavaDoc to comply with Java 1.8

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to annotated tag org.apache.sling.scripting.sightly.js.provider-1.0.10
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-js-provider.git

commit 435c51e900daadf02951d0d6d3007c323c573f84
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Tue Jul 14 12:01:57 2015 +0000

    trivial: corrected JavaDoc to comply with Java 1.8
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/scripting/sightly/js-use-provider@1690909 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/sling/scripting/sightly/js/impl/JsEnvironment.java   | 6 ++++--
 .../org/apache/sling/scripting/sightly/js/impl/JsUseProvider.java   | 2 +-
 .../scripting/sightly/js/impl/jsapi/SlyBindingsValuesProvider.java  | 3 +--
 .../apache/sling/scripting/sightly/js/impl/rhino/HybridObject.java  | 2 +-
 4 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsEnvironment.java b/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsEnvironment.java
index a82b264..3d95960 100644
--- a/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsEnvironment.java
+++ b/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsEnvironment.java
@@ -122,9 +122,11 @@ public class JsEnvironment {
 
     /**
      * Run a script at a given path
-     * @param caller the resource of the script that invokes the Js code
-     * @param path the path to the JS script
+     *
+     * @param caller         the resource of the script that invokes the Js code
+     * @param path           the path to the JS script
      * @param globalBindings bindings for the JS script
+     * @param arguments      the arguments for the JS script
      * @return an asynchronous container for the result
      * @throws UnsupportedOperationException if this method is run when the event loop is not empty
      */
diff --git a/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsUseProvider.java b/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsUseProvider.java
index 2f6f3b5..51cc57d 100644
--- a/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsUseProvider.java
+++ b/src/main/java/org/apache/sling/scripting/sightly/js/impl/JsUseProvider.java
@@ -55,7 +55,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Use provider for JS scripts. Ensures proper integration between Sightly & JS code-behind.
+ * Use provider for JavaScript Use-API objects.
  */
 @Component(
         metatype = true,
diff --git a/src/main/java/org/apache/sling/scripting/sightly/js/impl/jsapi/SlyBindingsValuesProvider.java b/src/main/java/org/apache/sling/scripting/sightly/js/impl/jsapi/SlyBindingsValuesProvider.java
index 6731ed4..71fc67c 100644
--- a/src/main/java/org/apache/sling/scripting/sightly/js/impl/jsapi/SlyBindingsValuesProvider.java
+++ b/src/main/java/org/apache/sling/scripting/sightly/js/impl/jsapi/SlyBindingsValuesProvider.java
@@ -64,8 +64,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Provides the {@code sightly} namespace for usage in Sightly & JS scripts
- * called from Sightly
+ * Provides the {@code sightly} namespace for usage in Sightly &amp; JS scripts called from Sightly
  */
 @Component(metatype = true, label = "Apache Sling Scripting Sightly JavaScript Bindings Provider",
         description = "The Apache Sling Scripting Sightly JavaScript Bindings Provider loads the JS Use-API and makes it available in the" +
diff --git a/src/main/java/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject.java b/src/main/java/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject.java
index 2d52120..7781eb0 100644
--- a/src/main/java/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject.java
+++ b/src/main/java/org/apache/sling/scripting/sightly/js/impl/rhino/HybridObject.java
@@ -29,7 +29,7 @@ import org.mozilla.javascript.ScriptableObject;
 
 
 /**
- * Instances of this class can be used in both Sightly & JS scripts
+ * Instances of this class can be used in both Sightly &amp; JavaScript scripts.
  */
 public class HybridObject implements Scriptable, Record<Object> {
 

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.