svn commit: r1772054 - in /sling/trunk/bundles/api/src/main/java/org/apache/sling/api: resource/Resource.java servlets/ServletResolverConstants.java

[ra...@apache.org]

Author: radu
Date: Wed Nov 30 15:33:34 2016
New Revision: 1772054

URL: http://svn.apache.org/viewvc?rev=1772054&view=rev
Log:
trivial: corrected JavaDoc

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/servlets/ServletResolverConstants.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java?rev=1772054&r1=1772053&r2=1772054&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java Wed Nov 30 15:33:34 2016
@@ -180,8 +180,13 @@ public interface Resource extends Adapta
 
     /**
      * Is just a shortcut for {@code getResourceResolver().isResourceType(this, resourceType)}.
+     *
+     * @param resourceType the resource type to check this resource against
      * @see ResourceResolver#isResourceType(Resource, String)
      * @since 2.1.0 (Sling API Bundle 2.1.0)
+     * @return <code>true</code> if the resource type or any of the resource's
+     *         super type(s) equals the given resource type, <code>false</code> otherwise;
+     *         <code>false</code> can also be returned if <code>resourceType</code> is null
      */
     boolean isResourceType(String resourceType);
 

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/servlets/ServletResolverConstants.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/servlets/ServletResolverConstants.java?rev=1772054&r1=1772053&r2=1772054&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/servlets/ServletResolverConstants.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/servlets/ServletResolverConstants.java Wed Nov 30 15:33:34 2016
@@ -44,7 +44,8 @@ public final class ServletResolverConsta
      * If both are set the servlet is registered using both ways.
      * <p>
      * A servlet using this property might be ignored unless its path is included 
-     * in the Execution Paths {@code servletresolver.paths} configuration setting of the {@link org.apache.sling.servlets.resolver.internal.SlingServletResolver} service.
+     * in the Execution Paths {@code servletresolver.paths} configuration setting of the
+     * {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver} service.
      */
     public static final String SLING_SERVLET_PATHS = "sling.servlet.paths";
 
@@ -65,11 +66,12 @@ public final class ServletResolverConsta
     public static final String SLING_SERVLET_RESOURCE_TYPES = "sling.servlet.resourceTypes";
 
     /**
+     * <p>
      * The name of the service registration property of a servlet registered as
      * a service providing the prefix/index to be used to register this servlet.
      * It only is applied as prefix to {@link #SLING_SERVLET_PATHS} and 
      * {@link #SLING_SERVLET_RESOURCE_TYPES} in case they do not start with a "/".
-     * <p>
+     * </p>
      * <ul>
      * <li>If the value of this property is a number, it defines the index of the search
      * path entries from the resource resolver. The defined search path is used as
@@ -82,7 +84,8 @@ public final class ServletResolverConsta
      * as a prefix, regardless of the configured search paths!</li>
      * <li>If the value is anything else, it is ignored.</li>
      * </ul>
-     * If this property is not specified, the configuration of the {@link org.apache.sling.servlets.resolver.internal.SlingServletResolver} service is used.
+     * If this property is not specified, the configuration of the {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver}
+     * service is used.
      * In case even that one is not set "/" is used as prefix.
      */
     public static final String SLING_SERVLET_PREFIX = "sling.servlet.prefix";
@@ -133,7 +136,7 @@ public final class ServletResolverConsta
      * <code>component.name</code> property or the <code>service.pid</code>
      * is used. If none of the three properties is defined, the Servlet is
      * ignored.
-     * @see {@link ServletConfig#getServletName()}
+     * @see ServletConfig#getServletName()
      */
     public static final String SLING_SERVLET_NAME = "sling.core.servletName";
 
@@ -141,7 +144,7 @@ public final class ServletResolverConsta
      * The resource type of a registered servlet used as the default servlet if
      * no other (more specific) servlet or script could be selected (value is
      * "sling/servlet/default"). If no servlet is registered under this name,
-     * the {@link org.apache.sling.servlets.resolver.internal.defaults.DefaultServlet} is
+     * the {@code org.apache.sling.servlets.resolver.internal.defaults.DefaultServlet} is
      * used.
      * @see <a href="http://sling.apache.org/documentation/the-sling-engine/servlets.html#default-servlets">Default Servlet(s)</a>
      */