Add JavaDoc and fix metrics

Author: rubengees

library/src/main/java/com/proxerme/library/connection/anime/AnimeRequest.java

@@ -5,9 +5,9 @@
 import com.proxerme.library.connection.ProxerRequest;
 
 /**
- * TODO: Describe class
+ * Base request for all requests in the "anime" API class.
  *
- * @author Ruben Gees
+ * @author Desnoo
  */
 public abstract class AnimeRequest<T> extends ProxerRequest<T> {
 

library/src/main/java/com/proxerme/library/connection/anime/entity/Stream.java

@@ -11,7 +11,7 @@
 import com.squareup.moshi.Json;
 
 /**
- * TODO: Describe class
+ * Entity representing a single streaming option of an anime.
  *
  * @author Ruben Gees
  */
@@ -50,6 +50,20 @@ public Stream[] newArray(int size) {
     @Json(name = "htype")
     private String hosterType;
 
+    /**
+     * The constructor.
+     *
+     * @param id         The id of the stream.
+     * @param hoster     The hoster.
+     * @param hosterName The name of the hoster.
+     * @param imageId    The image.
+     * @param uploaderId THe id of the uploader.
+     * @param uploader   The username of the uploader.
+     * @param time       The time this streams was linked.
+     * @param subgroupId The id of the subgroup if existent
+     * @param subgroup   The name of the subgroup if existent.
+     * @param hosterType The type of the hoster.
+     */
     public Stream(@NonNull String id, @NonNull String hoster, @NonNull String hosterName,
                   @NonNull String imageId, @NonNull String uploaderId, @NonNull String uploader,
                   long time, @Nullable String subgroupId, @Nullable String subgroup,
@@ -79,53 +93,103 @@ protected Stream(Parcel in) {
         this.hosterType = in.readString();
     }
 
+    /**
+     * Returns the id.
+     *
+     * @return The id.
+     */
     @NonNull
     @Override
     public String getId() {
         return id;
     }
 
+    /**
+     * Returns the hoster.
+     *
+     * @return The hoster.
+     */
     @NonNull
     public String getHoster() {
         return hoster;
     }
 
+    /**
+     * Returns the name of the hoster.
+     *
+     * @return The name of the hoster.
+     */
     @NonNull
     public String getHosterName() {
         return hosterName;
     }
 
+    /**
+     * Returns the image.
+     *
+     * @return The image.
+     */
     @NonNull
     @Override
     public String getImageId() {
         return imageId;
     }
 
+    /**
+     * Returns the id of the uploader.
+     *
+     * @return The id of the uploader.
+     */
     @NonNull
     public String getUploaderId() {
         return uploaderId;
     }
 
+    /**
+     * Returns the username of the uploader.
+     *
+     * @return The username of the uploader.
+     */
     @NonNull
     public String getUploader() {
         return uploader;
     }
 
+    /**
+     * Returns the time this stream was linked.
+     *
+     * @return The time.
+     */
     @Override
     public long getTime() {
         return time;
     }
 
+    /**
+     * Returns the id of the subgroup or null if not present.
+     *
+     * @return The id.
+     */
     @Nullable
     public String getSubgroupId() {
         return subgroupId;
     }
 
+    /**
+     * Returns the name of the subgroup or null if not present.
+     *
+     * @return The name.
+     */
     @Nullable
     public String getSubgroup() {
         return subgroup;
     }
 
+    /**
+     * Returns the type of the hoster.
+     *
+     * @return The type of the hoster.
+     */
     @NonNull
     public String getHosterType() {
         return hosterType;

library/src/main/java/com/proxerme/library/connection/anime/request/LinkRequest.java

@@ -14,7 +14,7 @@
 import okhttp3.ResponseBody;
 
 /**
- * TODO: Describe class
+ * Request for retrieving the link of a stream. This is no direct link.
  *
  * @author Ruben Gees
  */

library/src/main/java/com/proxerme/library/connection/anime/request/StreamsRequest.java

@@ -17,7 +17,8 @@
 import okhttp3.ResponseBody;
 
 /**
- * TODO: Describe class
+ * Request for retrieving all streams for a specified episode of an anime (by id) with a specific
+ * language.
  *
  * @author Ruben Gees
  */
@@ -34,7 +35,7 @@ public class StreamsRequest extends AnimeRequest<Stream[]> {
     private int episode;
     private String language;
 
-    private boolean withProxerStreams;
+    private boolean includeProxerStreams;
 
     /**
      * The constructor.
@@ -50,8 +51,15 @@ public StreamsRequest(@NonNull String id, @IntRange(from = 1) int episode,
         this.language = language;
     }
 
-    public StreamsRequest withProxerStreams(boolean enable) {
-        this.withProxerStreams = enable;
+    /**
+     * Sets if Proxer-streams should be included. Those require the highest permission level 3.
+     *
+     * @param includeProxerStreams True if streams should be included. The request will fail and not
+     *                             return if the user has not sufficient rights.
+     * @return This request.
+     */
+    public StreamsRequest withIncludeProxerStreams(boolean includeProxerStreams) {
+        this.includeProxerStreams = includeProxerStreams;
 
         return this;
     }
@@ -65,7 +73,7 @@ protected ProxerResult<Stream[]> parse(@NonNull Moshi moshi, @NonNull ResponseBo
     @NonNull
     @Override
     protected String getApiEndpoint() {
-        if (withProxerStreams) {
+        if (includeProxerStreams) {
             return STREAMS_WITH_PROXER;
         } else {
             return STREAMS;