Fix metrics and document ChapterRequest related classes

Author: rubengees

library/src/androidTest/java/com/proxerme/library/connection/manga/request/ChapterRequestTest.java

@@ -7,7 +7,6 @@
 import com.proxerme.library.test.R;
 import com.proxerme.library.util.RequestTest;
 
-import org.junit.Assert;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
@@ -18,7 +17,7 @@
 import static junit.framework.Assert.assertEquals;
 
 /**
- * TODO: Describe class
+ * Tests for {@link ChapterRequest}.
  *
  * @author Ruben Gees
  */
@@ -46,7 +45,7 @@ public void testUrl() throws Exception {
                 new ChapterRequest("0", 1, GeneralLanguageParameter.ENGLISH)
                         .withCustomHost(buildHostUrl(server.url(URL))));
 
-        Assert.assertEquals(URL, server.takeRequest().getPath());
+        assertEquals(URL, server.takeRequest().getPath());
     }
 
     private Chapter generateTestChapter() {
@@ -56,4 +55,4 @@ private Chapter generateTestChapter() {
                         new String[]{"fairy-001-02-03.jpg", "641", "900",},
                 });
     }
-}
+}

library/src/main/java/com/proxerme/library/connection/manga/entity/Chapter.java

@@ -13,7 +13,7 @@
 import java.util.Arrays;
 
 /**
- * TODO: Describe class
+ * Entity representing a single chapter of a maga.
  *
  * @author Ruben Gees
  */
@@ -52,6 +52,20 @@ public Chapter[] newArray(int size) {
     @Json(name = "pages")
     private String[][] pages;
 
+    /**
+     * The constructor.
+     *
+     * @param id          The id.
+     * @param entryId     The id of the associated entry.
+     * @param title       The title.
+     * @param uploaderId  The id of the uploader.
+     * @param uploader    The username of the uploader.
+     * @param time        The time this chapter was uploaded as an unix timestamp.
+     * @param scangroupId The id of the scangroup.
+     * @param scangroup   The name of the scangroup.
+     * @param server      The server this chapter is uploaded to.
+     * @param pages       The pages this chapter has.
+     */
     public Chapter(@NonNull String id, @NonNull String entryId, @NonNull String title,
                    @NonNull String uploaderId, @NonNull String uploader, long time,
                    @Nullable String scangroupId, @Nullable String scangroup, @NonNull String server,
@@ -81,52 +95,102 @@ protected Chapter(Parcel in) {
         this.pages = Utils.toTwoDimensions(3, in.createStringArray());
     }
 
+    /**
+     * Returns the id.
+     *
+     * @return The id.
+     */
     @Override
     @NonNull
     public String getId() {
         return id;
     }
 
+    /**
+     * Returns the id of the entry.
+     *
+     * @return The id of the entry.
+     */
     @NonNull
     public String getEntryId() {
         return entryId;
     }
 
+    /**
+     * Returns the title.
+     *
+     * @return The title.
+     */
     @NonNull
     public String getTitle() {
         return title;
     }
 
+    /**
+     * Returns the id of the uploader.
+     *
+     * @return The id of the uploader.
+     */
     @NonNull
     public String getUploaderId() {
         return uploaderId;
     }
 
+    /**
+     * Returns the name of the uploader.
+     *
+     * @return The name of the uploader.
+     */
     @NonNull
     public String getUploader() {
         return uploader;
     }
 
+    /**
+     * Returns the upload time.
+     *
+     * @return The upload time.
+     */
     @Override
     public long getTime() {
         return time;
     }
 
+    /**
+     * Returns the id of the scangroup.
+     *
+     * @return The id of the scangroup.
+     */
     @Nullable
     public String getScangroupId() {
         return scangroupId;
     }
 
+    /**
+     * Returns the name of the scangroup.
+     *
+     * @return The scangroup.
+     */
     @Nullable
     public String getScangroup() {
         return scangroup;
     }
 
+    /**
+     * Returns the server for this chapter.
+     *
+     * @return The server.
+     */
     @NonNull
     public String getServer() {
         return server;
     }
 
+    /**
+     * Returns an array of pages this chapter has.
+     *
+     * @return The pages.
+     */
     @NonNull
     public Page[] getPages() {
         Page[] result = new Page[pages.length];

library/src/main/java/com/proxerme/library/connection/manga/entity/Page.java

@@ -6,7 +6,7 @@
 import android.support.annotation.NonNull;
 
 /**
- * TODO: Describe class
+ * Entity representing a single page from a {@link Chapter}.
  *
  * @author Ruben Gees
  */
@@ -28,6 +28,13 @@ public Page[] newArray(int size) {
     private int height;
     private int width;
 
+    /**
+     * The constructor.
+     *
+     * @param name   The name of the file.
+     * @param height The height of the image.
+     * @param width  The width of the image.
+     */
     public Page(@NonNull String name, @IntRange(from = 0) int height,
                 @IntRange(from = 0) int width) {
         this.name = name;
@@ -41,16 +48,31 @@ protected Page(Parcel in) {
         this.width = in.readInt();
     }
 
+    /**
+     * Returns the filename.
+     *
+     * @return The filename.
+     */
     @NonNull
     public String getName() {
         return name;
     }
 
+    /**
+     * Returns the height.
+     *
+     * @return The height.
+     */
     @IntRange(from = 0)
     public int getHeight() {
         return height;
     }
 
+    /**
+     * Returns the width.
+     *
+     * @return The width.
+     */
     @IntRange(from = 0)
     public int getWidth() {
         return width;

library/src/main/java/com/proxerme/library/connection/manga/request/ChapterRequest.java

@@ -17,7 +17,8 @@
 import okhttp3.ResponseBody;
 
 /**
- * TODO: Describe class
+ * Request for retrieving information on a single chapter of the specified manga. A user must be
+ * logged in to earn points.
  *
  * @author Ruben Gees
  */
@@ -33,6 +34,13 @@ public class ChapterRequest extends MangaRequest<Chapter> {
     private int episode;
     private String language;
 
+    /**
+     * The constructor.
+     *
+     * @param id       The id of the manga.
+     * @param episode  The episode.
+     * @param language The selected language.
+     */
     public ChapterRequest(@NonNull String id, @IntRange(from = 1) int episode,
                           @NonNull @GeneralLanguage String language) {
         this.id = id;

library/src/main/java/com/proxerme/library/connection/manga/result/ChapterResult.java

@@ -5,9 +5,7 @@
 import com.squareup.moshi.Json;
 
 /**
- * TODO: Describe class
- *
- * @author Ruben Gees
+ * {@inheritDoc}
  */
 public final class ChapterResult extends ProxerResult<Chapter> {