Added documentation to PerspectiveAPI

Author: Ben McLean

src/au/com/origma/perspectiveapi/v1alpha1/PerspectiveAPI.java

@@ -9,13 +9,39 @@
 import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentRequest;
 import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentResponse;
 
+/**
+ * Interact with Google's PerspectiveAPI to analyze comments and content.<br>
+ * See the API documentation
+ * <a href="https://github.com/conversationai/perspectiveapi/blob/master/2-api/README.md">here</a>
+ * 
+ * @author Ben McLean &lt;ben@origma.com.au&gt;
+ */
 public interface PerspectiveAPI {
 
+	/**
+	 * The endpoint to which analysis requests are sent
+	 */
 	public static final String ANALYZE_ENDPOINT = "https://commentanalyzer.googleapis.com/v1alpha1/comments:analyze";
 
+	/**
+	 * Analyze a comment
+	 * @param request The request
+	 * @return The analysis of the request
+	 */
 	public AnalyzeCommentResponse analyze(AnalyzeCommentRequest request);
+	
+	/**
+	 * Analyze a comment with the default settings
+	 * @param comment The comment to analyze
+	 * @return The analysis of the request
+	 */
 	public AnalyzeCommentResponse analyze(String comment);
 
+	/**
+	 * Instantiate the default implementation of the PerspectiveAPI
+	 * @param apiKey The Google API key
+	 * @return The default implementation of the PerspectiveAPI
+	 */
 	public static PerspectiveAPI create(String apiKey) {
 		return new UnirestPerspectiveAPI(apiKey);
 	}

src/au/com/origma/perspectiveapi/v1alpha1/UnirestPerspectiveAPI.java

@@ -14,6 +14,11 @@
 import kong.unirest.HttpResponse;
 import kong.unirest.Unirest;
 
+/**
+ * The default implementation of the PerspectiveAPI client, made using the Unirest library
+ * 
+ * @author Ben McLean <ben@origma.com.au>
+ */
 public class UnirestPerspectiveAPI implements PerspectiveAPI {
 
 	String apiKey;

src/au/com/origma/perspectiveapi/v1alpha1/models/AnalyzeCommentRequest.java

@@ -13,7 +13,7 @@
 
 /**
  * A request to analyze a string of text for attributes
- * @author Ben McLean > ben@origma.com.au <
+ * @author Ben McLean <ben@origma.com.au>
  */
 public class AnalyzeCommentRequest {
 
@@ -93,7 +93,7 @@ public Double getSuggestCommentScore() {
 	/**
 	 * Builds an AnalyzeCommentRequest
 	 * 
-	 * @author Ben McLean > ben@origma.com.au <
+	 * @author Ben McLean <ben@origma.com.au>
 	 *
 	 */
 	public static class Builder {
@@ -213,7 +213,7 @@ public Builder suggestCommentScore(Double suggestCommentScore) {
 
 		/**
 		 * Build and create a new instance of AnalyzeCommentRequest
-		 * @return
+		 * @return The builder
 		 */
 		public AnalyzeCommentRequest build() {
 			return new AnalyzeCommentRequest(this);