svn commit: r1769739 - in /sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot: SlingshotUtil.java comments/CommentsService.java impl/SetupService.java

[cz...@apache.org]

Author: cziegeler
Date: Tue Nov 15 06:48:59 2016
New Revision: 1769739

URL: http://svn.apache.org/viewvc?rev=1769739&view=rev
Log:
Some javadoc updates

Modified:
    sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java
    sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java
    sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java

Modified: sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java
URL: http://svn.apache.org/viewvc/sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java?rev=1769739&r1=1769738&r2=1769739&view=diff
==============================================================================
--- sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java (original)
+++ sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java Tue Nov 15 06:48:59 2016
@@ -21,6 +21,11 @@ import org.apache.sling.api.resource.Res
 
 public abstract class SlingshotUtil {
 
+    /**
+     * Get the user id for a resource
+     * @param resource The resource of a user
+     * @return The user id or {@code null}.
+     */
     public static String getUserId(final Resource resource) {
         final String prefix = SlingshotConstants.APP_ROOT_PATH + "/";
 
@@ -39,6 +44,11 @@ public abstract class SlingshotUtil {
         return id;
     }
 
+    /**
+     * Get the user content path for the resource
+     * @param resource The resource
+     * @return The user content path or {@code null}.
+     */
     public static String getContentPath(final Resource resource) {
         final String prefix = SlingshotConstants.APP_ROOT_PATH + "/users/" + getUserId(resource) + "/";
 
@@ -49,6 +59,11 @@ public abstract class SlingshotUtil {
         return null;
     }
 
+    /**
+     * Checks whether the request is from a known user or from anonymous
+     * @param request The request
+     * @return {@code true} if it is a known user.
+     */
     public static boolean isUser(final SlingHttpServletRequest request) {
         final boolean isUser = request.getRemoteUser() != null && !request.getRemoteUser().equals("anonymous");
         return isUser;

Modified: sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java
URL: http://svn.apache.org/viewvc/sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java?rev=1769739&r1=1769738&r2=1769739&view=diff
==============================================================================
--- sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java (original)
+++ sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java Tue Nov 15 06:48:59 2016
@@ -33,6 +33,12 @@ public interface CommentsService {
      */
     String getCommentsResourcePath(final Resource resource);
 
+    /**
+     * Add a comment to the resource
+     * @param resource The resource
+     * @param c The commoent
+     * @throws PersistenceException If the comment can't be added
+     */
     void addComment(final Resource resource, final Comment c)
     throws PersistenceException;
 }

Modified: sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java
URL: http://svn.apache.org/viewvc/sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java?rev=1769739&r1=1769738&r2=1769739&view=diff
==============================================================================
--- sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java (original)
+++ sling/trunk/samples/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java Tue Nov 15 06:48:59 2016
@@ -38,7 +38,8 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The setup service sets up difference things.
+ * The setup service checks the resource types for the main folders,
+ * as some of them can't be set through initial content.
  */
 @Component
 public class SetupService {