javadoc improvements

Author: erosb

core/src/main/java/org/everit/json/schema/FormatValidator.java

@@ -49,6 +49,10 @@ public interface FormatValidator {
    * <li>ipv4</li>
    * <li>ipv6</li>
    * </ul>
+   *
+   * @param formatName
+   *          one of the 6 built-in formats.
+   * @return a {@code FormatValidator} implementation handling the {@code formatName} format.
    */
   static FormatValidator forFormat(final String formatName) {
     Objects.requireNonNull(formatName, "formatName cannot be null");

core/src/main/java/org/everit/json/schema/StringSchema.java

@@ -51,6 +51,10 @@ public StringSchema build() {
      * Setter for the format validator. It should be used in conjunction with
      * {@link FormatValidator#forFormat(String)} if a {@code "format"} value is found in a schema
      * json.
+     *
+     * @param formatValidator
+     *          the format validator
+     * @return {@code this}
      */
     public Builder formatValidator(final FormatValidator formatValidator) {
       this.formatValidator = Objects.requireNonNull(formatValidator,

core/src/main/java/org/everit/json/schema/internal/IPAddressValidator.java

@@ -26,8 +26,12 @@
 public class IPAddressValidator {
 
   /**
-   * Creates an InetAddress instance if possible and returns it, or on failure it returns
-   * Optional.empty().
+   * Creates an {@link InetAddress} instance if possible and returns it, or on failure it returns
+   * {@code Optional.empty()}.
+   *
+   * @param subject
+   *          the string to be validated.
+   * @return the optional validation failure message
    */
   protected Optional<InetAddress> asInetAddress(final String subject) {
     try {
@@ -43,6 +47,17 @@ protected Optional<InetAddress> asInetAddress(final String subject) {
 
   /**
    * Checks an IP address.
+   *
+   * @param subject
+   *          the string to be validated.
+   * @param expectedLength
+   *          the expected length of {@code subject} - it is validated if
+   *          {@link #asInetAddress(String)} validation succeeds.
+   * @param failureFormat
+   *          the {@link String#format(String, Object...) string format} of the validation failue
+   *          message. The format string will receive only the {@code subject} parameter (so it has
+   *          to be referred as {@code %s} in the format string
+   * @return the optional validation failure message
    */
   protected Optional<String> checkIpAddress(final String subject, final int expectedLength,
       final String failureFormat) {

core/src/main/java/org/everit/json/schema/loader/SchemaLoader.java

@@ -214,6 +214,13 @@ public static Schema load(final JSONObject schemaJson, final SchemaClient httpCl
 
   /**
    * Constructor.
+   *
+   * @param builder
+   *          the builder containing the properties. Only {@link SchemaLoaderBuilder#id} is
+   *          nullable.
+   * @throws NullPointerException
+   *           if any of the builder properties except {@link SchemaLoaderBuilder#id id} is
+   *           {@code null}.
    */
   public SchemaLoader(final SchemaLoaderBuilder builder) {
     this.schemaJson = Objects.requireNonNull(builder.schemaJson, "schemaJson cannot be null");