Code style and general quality adjustments

proxer · Feb 7, 2017 · 1553b61 · 1553b61
1 parent 639009f
commit 1553b61
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 8 deletions.
diff --git a/library/src/main/java/com/proxerme/library/connection/EmptyResult.java b/library/src/main/java/com/proxerme/library/connection/EmptyResult.java
@@ -3,16 +3,19 @@
 import android.support.annotation.Nullable;
 
 /**
- * TODO: Describe class
+ * Empty result for APIs that don't return anything, like the
+ * {@link com.proxerme.library.connection.ucp.request.DeleteReminderRequest}.
  *
  * @author Ruben Gees
  */
-
 public class EmptyResult extends ProxerResult<Void> {
 
     protected EmptyResult() {
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     @Nullable
     public Void getData() {

diff --git a/library/src/main/java/com/proxerme/library/connection/list/result/ProjectListResult.java b/library/src/main/java/com/proxerme/library/connection/list/result/ProjectListResult.java
@@ -19,4 +19,4 @@ protected ProjectListResult() {
     public ProjectListEntry[] getData() {
         return entries;
     }
-}
+}
diff --git a/library/src/main/java/com/proxerme/library/connection/user/request/UserCommentRequest.java b/library/src/main/java/com/proxerme/library/connection/user/request/UserCommentRequest.java
@@ -19,7 +19,8 @@
 import okhttp3.ResponseBody;
 
 /**
- * TODO: Describe class
+ * Request for the comments of a {@link com.proxerme.library.connection.user.entitiy.User}.
+ * Note: This API is currently incomplete.
  *
  * @author Ruben Gees
  */

diff --git a/library/src/main/java/com/proxerme/library/parameters/CountryParameter.java b/library/src/main/java/com/proxerme/library/parameters/CountryParameter.java
@@ -12,7 +12,7 @@
  *
  * @author Ruben Gees
  */
-public class CountryParameter {
+public final class CountryParameter {
 
     public static final String GERMAN = "de";
     public static final String ENGLISH = "en";

diff --git a/library/src/main/java/com/proxerme/library/parameters/IndustryTypeParameter.java b/library/src/main/java/com/proxerme/library/parameters/IndustryTypeParameter.java
@@ -12,7 +12,7 @@
  *
  * @author Ruben Gees
  */
-public class IndustryTypeParameter {
+public final class IndustryTypeParameter {
 
     public static final String PUBLISHER = "publisher";
     public static final String STUDIO = "studio";

diff --git a/library/src/main/java/com/proxerme/library/parameters/ProjectTypeParameter.java b/library/src/main/java/com/proxerme/library/parameters/ProjectTypeParameter.java
@@ -12,7 +12,7 @@
  *
  * @author Ruben Gees
  */
-public class ProjectTypeParameter {
+public final class ProjectTypeParameter {
 
     public static final int UNDEFINED = 0;
     public static final int FINISHED = 1;

diff --git a/library/src/main/java/com/proxerme/library/parameters/ShowHentaiParameter.java b/library/src/main/java/com/proxerme/library/parameters/ShowHentaiParameter.java
@@ -12,7 +12,7 @@
  *
  * @author Ruben Gees
  */
-public class ShowHentaiParameter {
+public final class ShowHentaiParameter {
 
     public static final int NO_HENTAI = -1;
     public static final int BOTH = 0;
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,4 +19,4 @@ protected ProjectListResult() { @@
         public ProjectListEntry[] getData() {
             return entries;
         }
-    }
+    }