From fd3597b3d13e89b575c2085acea2ec59fa0bd69f Mon Sep 17 00:00:00 2001 From: jendib Date: Tue, 13 Aug 2013 01:53:54 +0200 Subject: [PATCH] Cleanup javadoc --- .../com/sismics/util/JsonValidationUtil.java | 24 +++++++++---------- .../java/com/sismics/util/LocaleUtil.java | 2 +- .../com/sismics/util/mime/MimeTypeUtil.java | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs-core/src/main/java/com/sismics/util/JsonValidationUtil.java b/docs-core/src/main/java/com/sismics/util/JsonValidationUtil.java index 94173f59..ead4073e 100644 --- a/docs-core/src/main/java/com/sismics/util/JsonValidationUtil.java +++ b/docs-core/src/main/java/com/sismics/util/JsonValidationUtil.java @@ -14,9 +14,9 @@ public class JsonValidationUtil { /** * Checks if the JSON node contains the properties (not null). * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property - * @throws JSONException + * @throws Exception */ public static void validateJsonRequired(JsonNode n, String name) throws Exception { if (!n.has(name)) { @@ -27,10 +27,10 @@ public class JsonValidationUtil { /** * Checks that the property is a JSON object. * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property * @param required Property required - * @throws JSONException + * @throws Exception */ public static void validateJsonObject(JsonNode n, String name, boolean required) throws Exception { if (required && !n.has(name)) { @@ -44,10 +44,10 @@ public class JsonValidationUtil { /** * Checks that the property is a number. * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property * @param required Property required - * @throws JSONException + * @throws Exception */ public static void validateJsonNumber(JsonNode n, String name, boolean required) throws Exception { if (required && !n.has(name)) { @@ -61,10 +61,10 @@ public class JsonValidationUtil { /** * Checks that the property is a long. * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property * @param required Property required - * @throws JSONException + * @throws Exception */ public static void validateJsonLong(JsonNode n, String name, boolean required) throws Exception { if (required && !n.has(name)) { @@ -78,10 +78,10 @@ public class JsonValidationUtil { /** * Checks that the property is a string. * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property * @param required Property required - * @throws JSONException + * @throws Exception */ public static void validateJsonString(JsonNode n, String name, boolean required) throws Exception { if (required && !n.has(name)) { @@ -95,10 +95,10 @@ public class JsonValidationUtil { /** * Checks that the property is an array. * - * @param s JSON node to check + * @param n JSON node to check * @param name Name of the property * @param required Property required - * @throws JSONException + * @throws Exception */ public static void validateJsonArray(JsonNode n, String name, boolean required) throws Exception { if (required && !n.has(name)) { diff --git a/docs-core/src/main/java/com/sismics/util/LocaleUtil.java b/docs-core/src/main/java/com/sismics/util/LocaleUtil.java index df21454a..8799257f 100644 --- a/docs-core/src/main/java/com/sismics/util/LocaleUtil.java +++ b/docs-core/src/main/java/com/sismics/util/LocaleUtil.java @@ -36,7 +36,7 @@ public class LocaleUtil { /** * Extracts the ID of the locale from the HTTP Accept-Language header. * - * @param HTTP header + * @param acceptLanguageHeader header * @return Locale ID */ public static String getLocaleIdFromAcceptLanguage(String acceptLanguageHeader) { diff --git a/docs-core/src/main/java/com/sismics/util/mime/MimeTypeUtil.java b/docs-core/src/main/java/com/sismics/util/mime/MimeTypeUtil.java index 1fd5f556..82fa5faf 100644 --- a/docs-core/src/main/java/com/sismics/util/mime/MimeTypeUtil.java +++ b/docs-core/src/main/java/com/sismics/util/mime/MimeTypeUtil.java @@ -11,7 +11,7 @@ public class MimeTypeUtil { /** * Try to guess the MIME type of a file by its magic number (header). * - * @param file File to inspect + * @param is Stream to inspect * @return MIME type * @throws Exception */