Merge pull request #9 from MrSnix/experimental

Fixing javadocs warning

Author: MrSnix

src/main/java/org/tinyconfiguration/abc/AbstractConfiguration.java

@@ -33,6 +33,11 @@ protected AbstractConfiguration() {
 
     /**
      * Protected container constructor with parameters
+     *
+     * @param name     The configuration name
+     * @param version  The configuration version
+     * @param filename The configuration filename
+     * @param pathname The configuration pathname
      */
     protected AbstractConfiguration(String name, String version, String filename, String pathname) {
         this.name = name;

src/main/java/org/tinyconfiguration/abc/AbstractProperty.java

@@ -26,6 +26,10 @@ protected AbstractProperty() {
 
     /**
      * Protected constructor with parameters
+     *
+     * @param key         The property identifier
+     * @param value       The property default value
+     * @param description The property description
      */
     protected AbstractProperty(String key, Value value, String description) {
         this.key = key;

src/main/java/org/tinyconfiguration/abc/data/Value.java

@@ -55,7 +55,7 @@ public final boolean isArray() {
 
     /**
      * Check if the datatype object is a byte datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code byte}</li>
@@ -71,7 +71,7 @@ public final boolean isByte() {
 
     /**
      * Check if the datatype object is a byte array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code byte[]}</li>
@@ -89,7 +89,7 @@ public final boolean isByteArray() {
 
     /**
      * Check if the datatype object is a short datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code short}</li>
@@ -107,7 +107,7 @@ public final boolean isShort() {
 
     /**
      * Check if the datatype object is a short array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code short[]}</li>
@@ -124,7 +124,7 @@ public final boolean isShortArray() {
 
     /**
      * Check if the datatype object is an integer datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code int}</li>
@@ -140,7 +140,7 @@ public final boolean isInteger() {
 
     /**
      * Check if the datatype object is a int array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code int[]}</li>
@@ -157,7 +157,7 @@ public final boolean isIntegerArray() {
 
     /**
      * Check if the datatype object is a long datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code long}</li>
@@ -173,7 +173,7 @@ public final boolean isLong() {
 
     /**
      * Check if the datatype object is a long array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code long[]}</li>
@@ -190,7 +190,7 @@ public final boolean isLongArray() {
 
     /**
      * Check if the datatype object is a float datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code float}</li>
@@ -206,7 +206,7 @@ public final boolean isFloat() {
 
     /**
      * Check if the datatype object is a float array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code float[]}</li>
@@ -223,7 +223,7 @@ public final boolean isFloatArray() {
 
     /**
      * Check if the datatype object is a double datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code double}</li>
@@ -239,7 +239,7 @@ public final boolean isDouble() {
 
     /**
      * Check if the datatype object is a double array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code double[]}</li>
@@ -256,7 +256,7 @@ public final boolean isDoubleArray() {
 
     /**
      * Check if the datatype object is a boolean datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code boolean}</li>
@@ -272,7 +272,7 @@ public final boolean isBoolean() {
 
     /**
      * Check if the datatype object is a boolean array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code boolean[]}</li>
@@ -289,7 +289,7 @@ public final boolean isBooleanArray() {
 
     /**
      * Check if the datatype object is a character datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code character}</li>
@@ -305,7 +305,7 @@ public final boolean isCharacter() {
 
     /**
      * Check if the datatype object is a character array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code char[]}</li>
@@ -322,7 +322,7 @@ public final boolean isCharacterArray() {
 
     /**
      * Check if the datatype object is a string datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *    <li>{@code String}</li>
@@ -338,7 +338,7 @@ public final boolean isString() {
 
     /**
      * Check if the datatype object is a String array datatype
-     * <p></p>
+     *
      * <p>More specifically it looks on the following types:
      * <ul>
      *     <li>{@code String[]}</li>
@@ -355,7 +355,7 @@ public final boolean isStringArray() {
 
     /**
      * Check if the datatype object is a numeric datatype
-     * <p></p>
+     *
      * More it performs the following tests:
      * <ul>
      *    <li>{@link Value#isByte()} </li>
@@ -375,7 +375,7 @@ public final boolean isNumeric() {
 
     /**
      * Check if the datatype object is a numeric array datatype
-     * <p></p>
+     *
      * More specifically, it performs the following tests:
      *
      * <ul>
@@ -398,7 +398,7 @@ public final boolean isNumericArray() {
 
     /**
      * Check if the datatype object is a textual datatype
-     * <p></p>
+     *
      * More it performs the following tests:
      * <ul>
      *    <li>{@link Value#isCharacter()} </li>
@@ -414,7 +414,7 @@ public final boolean isText() {
 
     /**
      * Check if the datatype object is a textual array datatype
-     * <p></p>
+     *
      * More it performs the following tests:
      * <ul>
      *     <li>{@link Value#isArray()} </li>

src/main/java/org/tinyconfiguration/abc/io/handlers/AbstractReader.java

@@ -15,6 +15,7 @@ public interface AbstractReader<C extends AbstractConfiguration<?>, P extends Ab
      * This method allow to translate a property object inside an intermediate representation
      *
      * @param property The property instance
+     * @throws Exception If the decode process fails
      */
     void decode(P property) throws Exception;
 
@@ -30,6 +31,7 @@ public interface AbstractReader<C extends AbstractConfiguration<?>, P extends Ab
      * This method generate an intermediate object representation of the configuration from the file
      *
      * @param instance The configuration instance
+     * @return The new object representation
      * @throws Exception If something goes wrong during the process
      */
     Object fromFile(C instance) throws Exception;
@@ -39,6 +41,7 @@ public interface AbstractReader<C extends AbstractConfiguration<?>, P extends Ab
      *
      * @param property The property instance
      * @param obj      The intermediate object
+     * @throws Exception If the decode process fails
      */
     void __decode_obj(P property, I obj) throws Exception;
 
@@ -47,6 +50,7 @@ public interface AbstractReader<C extends AbstractConfiguration<?>, P extends Ab
      *
      * @param property The property instance
      * @param obj      The intermediate array
+     * @throws Exception If the decode process fails
      */
     void __decode_array(P property, I obj) throws Exception;
 }

src/main/java/org/tinyconfiguration/imp/basic/Configuration.java

@@ -191,7 +191,6 @@ public Builder setVersion(String version) {
         /**
          * Sets the configuration filename.
          *
-         * <p></p>
          * <p>This method is expecting a {@link String} value formatted as follow:</p>
          *
          * <ul>
@@ -222,7 +221,6 @@ public Builder setFilename(String filename) {
         /**
          * Sets the configuration pathname.
          *
-         * <p></p>
          * <p>This method is expecting a {@link String} value formatted as follow:</p>
          *
          * <ul>

src/main/java/org/tinyconfiguration/imp/basic/Property.java

@@ -67,7 +67,6 @@ public boolean isOptional() {
 
     /**
      * Gets the validity performing the specified {@link Predicate} test
-     * <p></p>
      * It returns <u>always</u> <b>true</b>, if no validation function was defined
      *
      * @return The boolean value representing the validity state