Add class-level Javadoc for sagan.blog.*

spring-attic · May 30, 2014 · cba334d · cba334d
1 parent f6193b4
commit cba334d
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 1 deletion.
diff --git a/sagan-common/src/main/java/sagan/blog/Post.java b/sagan-common/src/main/java/sagan/blog/Post.java
@@ -23,6 +23,9 @@
 
 import org.springframework.util.StringUtils;
 
+/**
+ * JPA Entity representing an individual blog post.
+ */
 @Entity
 @SuppressWarnings("serial")
 public class Post implements Serializable {

diff --git a/sagan-common/src/main/java/sagan/blog/PostCategory.java b/sagan-common/src/main/java/sagan/blog/PostCategory.java
@@ -1,5 +1,8 @@
 package sagan.blog;
 
+/**
+ * Available categories for blog posts.
+ */
 public enum PostCategory {
 
     ENGINEERING("Engineering", "engineering"),
@@ -30,5 +33,4 @@ public String getId() {
     public String toString() {
         return getDisplayName();
     }
-
 }
diff --git a/sagan-common/src/main/java/sagan/blog/PostMovedException.java b/sagan-common/src/main/java/sagan/blog/PostMovedException.java
@@ -1,7 +1,14 @@
 package sagan.blog;
 
+/**
+ * Exception thrown when requesting a blog post whose slug has changed. See
+ * {@code BlogController} for handling logic.
+ *
+ * @see sagan.blog.support.BlogService#getPublishedPost(String)
+ */
 @SuppressWarnings("serial")
 public class PostMovedException extends RuntimeException {
+
     private String publicSlug;
 
     public PostMovedException(String publicSlug) {

diff --git a/sagan-common/src/main/java/sagan/blog/PostNotFoundException.java b/sagan-common/src/main/java/sagan/blog/PostNotFoundException.java
@@ -2,6 +2,13 @@
 
 import sagan.support.ResourceNotFoundException;
 
+/**
+ * Exception thrown when requesting a non existent (or no-longer existent) blog post. See
+ * sagan-site's {@code MvcConfig#handleException} for handling logic.
+ *
+ * @see sagan.blog.support.BlogService#getPost(Long)
+ * @see sagan.blog.support.BlogService#getPublishedPost(String)
+ */
 @SuppressWarnings("serial")
 public class PostNotFoundException extends ResourceNotFoundException {