Add inheritDoc to all results

rubengees · rubengees · commit 438aa3305f7d · 2016-08-24T03:45:06.000+02:00
diff --git a/library/src/main/java/com/proxerme/library/connection/info/result/EntryDetailsResult.java b/library/src/main/java/com/proxerme/library/connection/info/result/EntryDetailsResult.java
@@ -2,14 +2,10 @@
 
 import com.proxerme.library.connection.ProxerResult;
 import com.proxerme.library.connection.info.entity.EntryDetails;
-import com.proxerme.library.connection.info.request.EntryDetailsRequest;
 import com.squareup.moshi.Json;
 
 /**
- * Holds the result of the
- * {@link EntryDetailsRequest}.
- *
- * @author Desnoo
+ * {@inheritDoc}
  */
 public final class EntryDetailsResult extends ProxerResult<EntryDetails> {
 
diff --git a/library/src/main/java/com/proxerme/library/connection/info/result/SeasonResult.java b/library/src/main/java/com/proxerme/library/connection/info/result/SeasonResult.java
@@ -5,10 +5,7 @@
 import com.squareup.moshi.Json;
 
 /**
- * Class that represents the result of the
- * {@link com.proxerme.library.connection.info.request.SeasonRequest}.
- *
- * @author Desnoo
+ * {@inheritDoc}
  */
 public final class SeasonResult extends ProxerResult<Season[]> {
 
diff --git a/library/src/main/java/com/proxerme/library/connection/info/result/SynonymResult.java b/library/src/main/java/com/proxerme/library/connection/info/result/SynonymResult.java
@@ -5,10 +5,7 @@
 import com.squareup.moshi.Json;
 
 /**
- * Class that represents the results of the
- * {@link com.proxerme.library.connection.info.request.SynonymRequest}.
- *
- * @author Desnoo
+ * {@inheritDoc}
  */
 public final class SynonymResult extends ProxerResult<Synonym[]> {
 
diff --git a/library/src/main/java/com/proxerme/library/connection/list/result/MediaListResult.java b/library/src/main/java/com/proxerme/library/connection/list/result/MediaListResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.list.entity.MediaListEntry;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class MediaListResult extends ProxerResult<MediaListEntry[]> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/ConferenceInfoResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/ConferenceInfoResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.messenger.entity.ConferenceInfoContainer;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class ConferenceInfoResult extends ProxerResult<ConferenceInfoContainer> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/ConferencesResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/ConferencesResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.messenger.entity.Conference;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class ConferencesResult extends ProxerResult<Conference[]> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/ConstantsResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/ConstantsResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.messenger.entity.Constants;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class ConstantsResult extends ProxerResult<Constants> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/MessagesResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/MessagesResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.messenger.entity.Message;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class MessagesResult extends ProxerResult<Message[]> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/ModifyConferenceResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/ModifyConferenceResult.java
@@ -4,6 +4,9 @@
 
 import com.proxerme.library.connection.ProxerResult;
 
+/**
+ * {@inheritDoc}
+ */
 public final class ModifyConferenceResult extends ProxerResult<Void> {
 
     @Override
diff --git a/library/src/main/java/com/proxerme/library/connection/messenger/result/SendMessageResult.java b/library/src/main/java/com/proxerme/library/connection/messenger/result/SendMessageResult.java
@@ -5,6 +5,9 @@
 import com.proxerme.library.connection.ProxerResult;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class SendMessageResult extends ProxerResult<String> {
 
     @Nullable
diff --git a/library/src/main/java/com/proxerme/library/connection/notifications/result/NewsResult.java b/library/src/main/java/com/proxerme/library/connection/notifications/result/NewsResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.notifications.entitiy.News;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class NewsResult extends ProxerResult<News[]> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/user/result/LoginResult.java b/library/src/main/java/com/proxerme/library/connection/user/result/LoginResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.user.entitiy.User;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class LoginResult extends ProxerResult<User> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/user/result/LogoutResult.java b/library/src/main/java/com/proxerme/library/connection/user/result/LogoutResult.java
@@ -4,6 +4,9 @@
 
 import com.proxerme.library.connection.ProxerResult;
 
+/**
+ * {@inheritDoc}
+ */
 public final class LogoutResult extends ProxerResult<Void> {
 
     @Override
diff --git a/library/src/main/java/com/proxerme/library/connection/user/result/ToptenResult.java b/library/src/main/java/com/proxerme/library/connection/user/result/ToptenResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.user.entitiy.ToptenEntry;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class ToptenResult extends ProxerResult<ToptenEntry[]> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/user/result/UserInfoResult.java b/library/src/main/java/com/proxerme/library/connection/user/result/UserInfoResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.user.entitiy.UserInfo;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class UserInfoResult extends ProxerResult<UserInfo> {
 
     @Json(name = "data")
diff --git a/library/src/main/java/com/proxerme/library/connection/user/result/UserMediaListResult.java b/library/src/main/java/com/proxerme/library/connection/user/result/UserMediaListResult.java
@@ -4,6 +4,9 @@
 import com.proxerme.library.connection.user.entitiy.UserMediaListEntry;
 import com.squareup.moshi.Json;
 
+/**
+ * {@inheritDoc}
+ */
 public final class UserMediaListResult extends ProxerResult<UserMediaListEntry[]> {
 
     @Json(name = "data")
