Some javadoc updates
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1769739 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java b/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java
index 5dc2a4d..2ae1718 100644
--- a/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java
+++ b/slingshot/src/main/java/org/apache/sling/sample/slingshot/SlingshotUtil.java
@@ -21,6 +21,11 @@
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 @@
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 @@
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;
diff --git a/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java b/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java
index 2964219..e9c1a15 100644
--- a/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java
+++ b/slingshot/src/main/java/org/apache/sling/sample/slingshot/comments/CommentsService.java
@@ -33,6 +33,12 @@
*/
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;
}
diff --git a/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java b/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java
index 7fc91d4..af79085 100644
--- a/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java
+++ b/slingshot/src/main/java/org/apache/sling/sample/slingshot/impl/SetupService.java
@@ -38,7 +38,8 @@
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 {
