diff --git a/src/main/java/com/omertron/themoviedbapi/AppendToResponseBuilder.java b/src/main/java/com/omertron/themoviedbapi/AppendToResponseBuilder.java index c9bcb9520..7b2418fcc 100644 --- a/src/main/java/com/omertron/themoviedbapi/AppendToResponseBuilder.java +++ b/src/main/java/com/omertron/themoviedbapi/AppendToResponseBuilder.java @@ -33,7 +33,7 @@ public class AppendToResponseBuilder { /** * Construct the builder with the first method * - * @param method + * @param method method */ public AppendToResponseBuilder(AppendToResponseMethod method) { response = new StringBuilder(method.getPropertyString()); @@ -42,7 +42,7 @@ public class AppendToResponseBuilder { /** * Generate the string * - * @return + * @return ATR string */ public String build() { return response.toString(); @@ -51,8 +51,8 @@ public class AppendToResponseBuilder { /** * Add a method to the list * - * @param method - * @return + * @param method method + * @return builder */ public AppendToResponseBuilder add(AppendToResponseMethod method) { response.append(",").append(method.getPropertyString()); diff --git a/src/main/java/com/omertron/themoviedbapi/Compare.java b/src/main/java/com/omertron/themoviedbapi/Compare.java index a9f2902a5..ec0954873 100644 --- a/src/main/java/com/omertron/themoviedbapi/Compare.java +++ b/src/main/java/com/omertron/themoviedbapi/Compare.java @@ -39,7 +39,7 @@ public class Compare { } /** - * Compare the MovieDB object with a title & year + * Compare the MovieDB object with a title and year * * @param moviedb The moviedb object to compare too * @param title The title of the movie to compare @@ -51,7 +51,7 @@ public class Compare { } /** - * Compare the MovieDB object with a title & year + * Compare the MovieDB object with a title and year * * @param moviedb The moviedb object to compare too * @param title The title of the movie to compare @@ -107,13 +107,13 @@ public class Compare { } /** - * Compare the MovieDB object with a title & year, case sensitive + * Compare the MovieDB object with a title and year, case sensitive * - * @param moviedb - * @param title - * @param year - * @param maxDistance - * @return + * @param moviedb movieinfo + * @param title title + * @param year year + * @param maxDistance maximum distance + * @return true if matched */ public static boolean movies(final MovieInfo moviedb, final String title, final String year, int maxDistance) { return Compare.movies(moviedb, title, year, maxDistance, true); @@ -122,9 +122,9 @@ public class Compare { /** * Compare the Levenshtein Distance between the two strings * - * @param title1 - * @param title2 - * @param distance + * @param title1 title + * @param title2 title + * @param distance max distance */ private static boolean compareDistance(final String title1, final String title2, int distance) { return StringUtils.getLevenshteinDistance(title1, title2) <= distance; @@ -133,7 +133,7 @@ public class Compare { /** * Check the year is not blank or UNKNOWN * - * @param year + * @param year year */ private static boolean isValidYear(final String year) { return StringUtils.isNotBlank(year) && !"UNKNOWN".equals(year); diff --git a/src/main/java/com/omertron/themoviedbapi/tools/TmdbParameters.java b/src/main/java/com/omertron/themoviedbapi/tools/TmdbParameters.java index bd8a92a54..92421b5c6 100644 --- a/src/main/java/com/omertron/themoviedbapi/tools/TmdbParameters.java +++ b/src/main/java/com/omertron/themoviedbapi/tools/TmdbParameters.java @@ -79,7 +79,7 @@ public class TmdbParameters { * Add an integer parameter to the collection * * @param key Parameter to add - * @param value The value to add (will be checked to ensure >0) + * @param value The value to add (will be checked to ensure greater than zero) */ public void add(final Param key, final Integer value) { if (value != null && value > 0) { @@ -91,7 +91,7 @@ public class TmdbParameters { * Add a float parameter to the collection * * @param key Parameter to add - * @param value The value to add (will be checked to ensure >0) + * @param value The value to add (will be checked to ensure greater than zero) */ public void add(final Param key, final Float value) { if (value != null && value > 0f) { @@ -103,7 +103,7 @@ public class TmdbParameters { * Add a boolean parameter to the collection * * @param key Parameter to add - * @param value The value to add (will be checked to ensure >0) + * @param value The value to add (will be checked to ensure greater than zero) */ public void add(final Param key, final Boolean value) { if (value != null) {