From 2de5728b3adf4bd3b7d398b157e1e7f635d7f46a Mon Sep 17 00:00:00 2001 From: Stuart Boston Date: Tue, 3 Apr 2018 20:53:15 +0100 Subject: [PATCH] Add javadoc --- .../com/omertron/themoviedbapi/enumeration/ArtworkType.java | 4 ++-- .../java/com/omertron/themoviedbapi/enumeration/Gender.java | 4 ++-- .../com/omertron/themoviedbapi/enumeration/MediaType.java | 4 ++-- .../com/omertron/themoviedbapi/enumeration/MovieMethod.java | 6 +++--- .../omertron/themoviedbapi/enumeration/PeopleMethod.java | 6 +++--- .../com/omertron/themoviedbapi/enumeration/ReleaseType.java | 4 ++-- .../omertron/themoviedbapi/enumeration/TVEpisodeMethod.java | 6 +++--- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/ArtworkType.java b/src/main/java/com/omertron/themoviedbapi/enumeration/ArtworkType.java index aaceafe24..9111ca99c 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/ArtworkType.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/ArtworkType.java @@ -46,8 +46,8 @@ public enum ArtworkType { /** * Convert a string into an Enum type * - * @param artworkType - * @return + * @param artworkType String to convert to enum + * @return enum version of param * @throws IllegalArgumentException If type is not recognised * */ diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/Gender.java b/src/main/java/com/omertron/themoviedbapi/enumeration/Gender.java index 10431ba83..ac0d0f729 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/Gender.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/Gender.java @@ -33,8 +33,8 @@ public enum Gender { /** * Get the gender from an integer type * - * @param type - * @return + * @param type Integer to convert to enum + * @return enum version of param */ public static Gender fromInteger(int type) { for (Gender gender : Gender.values()) { diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/MediaType.java b/src/main/java/com/omertron/themoviedbapi/enumeration/MediaType.java index cb3289884..153f6feb1 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/MediaType.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/MediaType.java @@ -48,8 +48,8 @@ public enum MediaType { /** * Convert a string into an Enum type * - * @param mediaType - * @return + * @param mediaType String to convert to enum + * @return enum version of param * @throws IllegalArgumentException If type is not recognised * */ diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/MovieMethod.java b/src/main/java/com/omertron/themoviedbapi/enumeration/MovieMethod.java index ffe03def3..e010ebfca 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/MovieMethod.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/MovieMethod.java @@ -45,7 +45,7 @@ public enum MovieMethod implements AppendToResponseMethod { /** * Get the string to use in the URL * - * @return + * @return the string representation of the enum */ @Override public String getPropertyString() { @@ -55,8 +55,8 @@ public enum MovieMethod implements AppendToResponseMethod { /** * Convert a string into an Enum type * - * @param method - * @return + * @param method String to convert to enum + * @return enum version of param * @throws IllegalArgumentException If type is not recognised * */ diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/PeopleMethod.java b/src/main/java/com/omertron/themoviedbapi/enumeration/PeopleMethod.java index 72214fbd4..f934239cd 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/PeopleMethod.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/PeopleMethod.java @@ -40,7 +40,7 @@ public enum PeopleMethod implements AppendToResponseMethod { /** * Get the string to use in the URL * - * @return + * @return the string representation of the enum */ @Override public String getPropertyString() { @@ -50,8 +50,8 @@ public enum PeopleMethod implements AppendToResponseMethod { /** * Convert a string into an Enum type * - * @param method - * @return + * @param method String to convert to enum + * @return enum version of param * @throws IllegalArgumentException If type is not recognised * */ diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/ReleaseType.java b/src/main/java/com/omertron/themoviedbapi/enumeration/ReleaseType.java index e2b8fbe86..a940b9855 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/ReleaseType.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/ReleaseType.java @@ -42,8 +42,8 @@ public enum ReleaseType { /** * Get the Release Type from an integer type * - * @param type - * @return + * @param type Integer to convert to enum + * @return enum version of param */ public static ReleaseType fromInteger(int type) { for (ReleaseType rt : ReleaseType.values()) { diff --git a/src/main/java/com/omertron/themoviedbapi/enumeration/TVEpisodeMethod.java b/src/main/java/com/omertron/themoviedbapi/enumeration/TVEpisodeMethod.java index d8cd454c2..a10f2e2fe 100644 --- a/src/main/java/com/omertron/themoviedbapi/enumeration/TVEpisodeMethod.java +++ b/src/main/java/com/omertron/themoviedbapi/enumeration/TVEpisodeMethod.java @@ -37,7 +37,7 @@ public enum TVEpisodeMethod implements AppendToResponseMethod { /** * Get the string to use in the URL * - * @return + * @return the string representation of the enum */ @Override public String getPropertyString() { @@ -47,8 +47,8 @@ public enum TVEpisodeMethod implements AppendToResponseMethod { /** * Convert a string into an Enum type * - * @param method - * @return + * @param method String to convert to enum + * @return enum version of param * @throws IllegalArgumentException If type is not recognised * */