Added documentation to score classes

Author: Ben McLean

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

@@ -146,7 +146,7 @@ public Builder addRequestedAttribute(AttributeType type, RequestedAttribute requ
 			if(requestedAttribute != null){
 				requestedAttributes.put(type, requestedAttribute);
 			}else{
-				requestedAttributes.put(type, new RequestedAttribute());
+				requestedAttributes.put(type, new RequestedAttribute.Builder().build());
 			}
 			return this;
 		}

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

@@ -6,51 +6,66 @@
  */
 package au.com.origma.perspectiveapi.v1alpha1.models;
 
+/**
+ * Represents the parameters of a requested attribute
+ * 
+ * @author Ben McLean <ben@origma.com.au>
+ *
+ */
 public class RequestedAttribute {
 
 	ScoreType scoreType;
 	Double scoreThreshold;
 
-	public RequestedAttribute() {
-		super();
-	}
-
-	public RequestedAttribute(ScoreType scoreType, Double scoreThreshold) {
-		super();
-		this.scoreType = scoreType;
-		this.scoreThreshold = scoreThreshold;
-	}
-
+	/**
+	 * Returns the score type of the attribute
+	 * @return the score type of the attribute
+	 */
 	public ScoreType getScoreType() {
 		return scoreType;
 	}
 
-	public void setScoreType(ScoreType scoreType) {
-		this.scoreType = scoreType;
-	}
-
+	/**
+	 * Returns the score threshold of the attribute
+	 * @return the score threshold of the attribute
+	 */
 	public Double getScoreThreshold() {
 		return scoreThreshold;
 	}
 
-	public void setScoreThreshold(Double scoreThreshold) {
-		this.scoreThreshold = scoreThreshold;
-	}
-
+	/**
+	 * Builds a RequestedAttribute
+	 * 
+	 * @author Ben McLean <ben@origma.com.au>
+	 */
 	public static class Builder {
 		private ScoreType scoreType;
 		private Double scoreThreshold;
 
+		/**
+		 * Sets the score type of the attribute
+		 * @param scoreType the score type of the attribute
+		 * @return The builder
+		 */
 		public Builder scoreType(ScoreType scoreType) {
 			this.scoreType = scoreType;
 			return this;
 		}
 
+		/**
+		 * Sets the score threshold of the attribute
+		 * @param scoreThreshold the score threshold of the attribute
+		 * @return The builder
+		 */
 		public Builder scoreThreshold(Double scoreThreshold) {
 			this.scoreThreshold = scoreThreshold;
 			return this;
 		}
 
+		/**
+		 * Builds a new instance of RequestedAttribute
+		 * @return a new instance of RequestedAttribute
+		 */
 		public RequestedAttribute build() {
 			return new RequestedAttribute(this);
 		}

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

@@ -6,31 +6,58 @@
  */
 package au.com.origma.perspectiveapi.v1alpha1.models;
 
+/**
+ * Represents the value of an analysis attribute
+ * 
+ * @author Ben McLean <ben@origma.com.au>
+ */
 public class Score {
 
 	float value;
 	ScoreType type;
 
+	/**
+	 * Create an empty instance
+	 */
 	public Score(){}
 
+	/**
+	 * Create an instance
+	 */
 	public Score(float value, ScoreType type) {
 		super();
 		this.value = value;
 		this.type = type;
 	}
 
+	/**
+	 * Returns the value of a score
+	 * @return the value of a score
+	 */
 	public float getValue() {
 		return value;
 	}
 
+	/**
+	 * Sets the value of a score
+	 * @param value the value of a score
+	 */
 	public void setValue(float value) {
 		this.value = value;
 	}
 
+	/**
+	 * Returns the type of a score
+	 * @return the type of a score
+	 */
 	public ScoreType getType() {
 		return type;
 	}
 
+	/**
+	 * Sets the type of a score
+	 * @param type the type of a score
+	 */
 	public void setType(ScoreType type) {
 		this.type = type;
 	}

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

@@ -6,6 +6,12 @@
  */
 package au.com.origma.perspectiveapi.v1alpha1.models;
 
+/**
+ * The form a score takes
+ * 
+ * @author Ben McLean <ben@origma.com.au>
+ *
+ */
 public enum ScoreType {
 	PROBABILITY
 }

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

@@ -5,42 +5,77 @@
  * Written by Ben McLean <ben@origma.com.au>, November 2019
  */
 package au.com.origma.perspectiveapi.v1alpha1.models;
-
+/**
+ * A score representing a span of the analyzed comment
+ * 
+ * @author Ben McLean &lt;ben@origma.com.au&gt;
+ *
+ */
 public class SpanScore {
 
 	int begin;
 	int end;
 	Score score;
 
+	/**
+	 * Create an empty instance
+	 */
 	public SpanScore(){}
 
+	/**
+	 * Create an instance
+	 */
 	public SpanScore(int begin, int end, Score score) {
 		super();
 		this.begin = begin;
 		this.end = end;
 		this.score = score;
 	}
 
+	/**
+	 * Returns the beginning position of the span
+	 * @return the beginning position of the span
+	 */
 	public int getBegin() {
 		return begin;
 	}
 
+	/**
+	 * Sets the beginning position of the span
+	 * @param begin the beginning position of the span
+	 */
 	public void setBegin(int begin) {
 		this.begin = begin;
 	}
 
+	/**
+	 * Returns the ending position of the span
+	 * @return the ending position of the span
+	 */
 	public int getEnd() {
 		return end;
 	}
 
+	/**
+	 * Sets the ending position of the span
+	 * @param end the ending position of the span
+	 */
 	public void setEnd(int end) {
 		this.end = end;
 	}
 
+	/**
+	 * Returns the score of the span
+	 * @return the score of the span
+	 */
 	public Score getScore() {
 		return score;
 	}
 
+	/**
+	 * Sets the score of the span
+	 * @param score the score of the span
+	 */
 	public void setScore(Score score) {
 		this.score = score;
 	}