You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2018/05/29 08:18:38 UTC

[sling-org-apache-sling-servlets-annotations] 06/09: SLING-7624 fix some more javadoc

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

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-annotations.git

commit 8cc20c309d58145c72c90e29948fa2ce1995051f
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri May 25 10:38:07 2018 +0200

    SLING-7624 fix some more javadoc
---
 pom.xml                                                   |  6 ------
 .../sling/servlets/annotations/SlingServletPaths.java     |  2 --
 .../sling/servlets/annotations/SlingServletPrefix.java    | 15 ++++-----------
 3 files changed, 4 insertions(+), 19 deletions(-)

diff --git a/pom.xml b/pom.xml
index 58e2e98..156322e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -53,12 +53,6 @@
             <version>2.16.0</version>
         </dependency>
         <dependency>
-            <groupId>org.apache.sling</groupId>
-            <artifactId>org.apache.sling.api</artifactId>
-            <!-- https://issues.apache.org/jira/browse/SLING-6249, only for link in javadoc -->
-            <version>2.16.0</version>
-        </dependency>
-        <dependency>
             <groupId>javax.servlet</groupId>
             <artifactId>javax.servlet-api</artifactId>
         </dependency>
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
index 61fe06d..f402b25 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
@@ -47,6 +47,4 @@ public @interface SlingServletPaths {
      * @see ServletResolverConstants#SLING_SERVLET_PATHS
      */
     String[] value();
-
-    // TODO: does not work due to https://github.com/bndtools/bnd/issues/2445
 }
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
index a34bbc5..7f3aab6 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
@@ -19,12 +19,10 @@ package org.apache.sling.servlets.annotations;
 import org.apache.sling.api.servlets.ServletResolverConstants;
 import org.osgi.service.component.annotations.ComponentPropertyType;
 /**
- * Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets.
- * Takes care of writing the relevant component properties as being used by the Sling Servlet Resolver ({@link ServletResolverConstants})
- * to register the annotated servlet component as Sling servlet for a specific path.
- * Preferably register Sling servlets by resource type ({@link SlingServletResourceTypes}) though 
- * for reasons outlined at <a href="https://sling.apache.org/documentation/the-sling-engine/servlets.html#caveats-when-binding-servlets-by-path">
- * Caveats when binding servlets by path</a>
+ * The prefix/index to be used to register this servlet.
+ * Must be used in combination with either {@link SlingServletPaths} or {@link SlingServletResourceTypes}.
+ * It only is applied as prefix to {@link SlingServletPaths} or {@link SlingServletResourceTypes#resourceTypes()} 
+ * in case they do not start with a "/".
  *
  * @see <a href="https://sling.apache.org/documentation/the-sling-engine/servlets.html">Sling Servlets</a>
  * @see ServletResolverConstants
@@ -34,10 +32,6 @@ import org.osgi.service.component.annotations.ComponentPropertyType;
 public @interface SlingServletPrefix {
 
     /**
-     * The prefix/index to be used to register this servlet.
-     * It only is applied as prefix to {@link SlingServletPaths} or {@link SlingServletResourceTypes#resourceTypes()} 
-     * in case they do not start with a "/".
-     * </p>
      * <ul>
      * <li>If the value of this element is a number, it defines the index of the search
      * path entries from the resource resolver. The defined search path is used as
@@ -56,5 +50,4 @@ public @interface SlingServletPrefix {
      * @see ServletResolverConstants#SLING_SERVLET_PREFIX
      */
     String value();
-    // TODO: does not work due to https://github.com/bndtools/bnd/issues/2445
 }

-- 
To stop receiving notification emails like this one, please contact
kwin@apache.org.