[sling-org-apache-sling-scripting-spi] branch master updated: trivial: corrected JavaDoc

[ra...@apache.org]

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

radu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-spi.git


The following commit(s) were added to refs/heads/master by this push:
     new 3923199  trivial: corrected JavaDoc
3923199 is described below

commit 39231997cd21c4d8650a4e6b367a7e1e93e222df
Author: Radu Cotescu <co...@adobe.com>
AuthorDate: Thu Apr 8 20:05:26 2021 +0200

    trivial: corrected JavaDoc
---
 .../scripting/spi/bundle/BundledRenderUnit.java      |  5 ++++-
 .../sling/scripting/spi/bundle/ResourceType.java     | 20 ++++++++++----------
 2 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/sling/scripting/spi/bundle/BundledRenderUnit.java b/src/main/java/org/apache/sling/scripting/spi/bundle/BundledRenderUnit.java
index 9c7edda..3f47e18 100644
--- a/src/main/java/org/apache/sling/scripting/spi/bundle/BundledRenderUnit.java
+++ b/src/main/java/org/apache/sling/scripting/spi/bundle/BundledRenderUnit.java
@@ -77,6 +77,8 @@ public interface BundledRenderUnit {
      * Bundle bundle = bundledRenderUnit.getBundle();
      * Classloader bundleClassloader = bundle.adapt(BundleWiring.class).getClassLoader();
      * </pre>
+     *
+     * @return the bundle providing this unit
      */
     @NotNull Bundle getBundle();
 
@@ -127,7 +129,8 @@ public interface BundledRenderUnit {
 
     /**
      * This method will execute / evaluate the wrapped script or precompiled script with the given request.
-     *
+     * @param request the request
+     * @param response the response
      * @throws ScriptException if the execution leads to an error
      */
     void eval(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response) throws ScriptException;
diff --git a/src/main/java/org/apache/sling/scripting/spi/bundle/ResourceType.java b/src/main/java/org/apache/sling/scripting/spi/bundle/ResourceType.java
index e409e2b..de65928 100644
--- a/src/main/java/org/apache/sling/scripting/spi/bundle/ResourceType.java
+++ b/src/main/java/org/apache/sling/scripting/spi/bundle/ResourceType.java
@@ -31,11 +31,11 @@ import org.osgi.framework.Version;
  *
  * <p>The following patterns are supported for parsing:</p>
  * <ol>
- * <li><tt>a/b/c</tt> - path-based</li>
- * <li><tt>a/b/c/1.0.0</tt> - path-based, versioned</li>
- * <li><tt>a.b.c</tt> - Java package name</li>
- * <li><tt>a.b.c/1.0.0</tt> - Java package name, versioned</li>
- * <li><tt>a</tt> - flat (sub-set of path-based)</li>
+ * <li><code>a/b/c</code> - path-based</li>
+ * <li><code>a/b/c/1.0.0</code> - path-based, versioned</li>
+ * <li><code>a.b.c</code> - Java package name</li>
+ * <li><code>a.b.c/1.0.0</code> - Java package name, versioned</li>
+ * <li><code>a</code> - flat (sub-set of path-based)</li>
  * </ol>
  */
 public final class ResourceType {
@@ -102,11 +102,11 @@ public final class ResourceType {
      * Given a {@code resourceTypeString}, this method will extract a {@link ResourceType} object.
      * <p>The accepted patterns are:</p>
      * <ol>
-     * <li><tt>a/b/c</tt> - path-based</li>
-     * <li><tt>a/b/c/1.0.0</tt> - path-based, versioned</li>
-     * <li><tt>a.b.c</tt> - Java package name</li>
-     * <li><tt>a.b.c/1.0.0</tt> - Java package name, versioned</li>
-     * <li><tt>a</tt> - flat (sub-set of path-based)</li>
+     * <li><code>a/b/c</code> - path-based</li>
+     * <li><code>a/b/c/1.0.0</code> - path-based, versioned</li>
+     * <li><code>a.b.c</code> - Java package name</li>
+     * <li><code>a.b.c/1.0.0</code> - Java package name, versioned</li>
+     * <li><code>a</code> - flat (sub-set of path-based)</li>
      * </ol>
      *
      * @param resourceTypeString the resource type string to parse