fixing javadocs...

Author: SimplyProgrammer

SerialX-core/src/main/java/org/ugp/serialx/Serializer.java

@@ -737,7 +737,7 @@ public void setFormat(byte format)
 			</tr>
 		    <tr>
 			    <td>{@link File}</td>
-			    <td>{@link Serializer#serializeTo(File)}</td>
+			    <td>{@link Serializer#serializeTo(File, Object...)}</td>
 			</tr>
 		    <tr>
 			    <td>{@link Appendable}</td>

SerialX-core/src/main/java/org/ugp/serialx/converters/DataParser.java

@@ -46,7 +46,7 @@ public interface DataParser
 	public static final ParserRegistry REGISTRY = new ParserRegistry(new VariableParser(), new StringConverter(), new ProtocolConverter(), new NumberConverter(), new BooleanConverter(), new CharacterConverter(), new NullConverter(), new SerializableBase64Converter());
 
 	/**
-	 * @param myHomeRegistry | Registry where this parser is registered provided by {@link DataParser#parse(String, boolean, Class, Object...)} otherwise it demands on implementation (it should not be null)!
+	 * @param myHomeRegistry | Registry where this parser is registered provided by {@link ParserRegistry#parse(String, boolean, Class, Object...)} otherwise it demands on implementation (it should not be null)!
 	 * @param str | Source string, preferably trimed!
 	 * @param args | Some additional args. This can be anything and it demands on implementation of DataParser. Default SerialX API implementation will provide one optional argument with {@link Scope} that value was loaded from!
 	 * 

SerialX-core/src/main/java/org/ugp/serialx/converters/ProtocolConverter.java

@@ -68,7 +68,7 @@ public class ProtocolConverter implements DataConverter
 	 * Note: Whole concept of SerialX API is about avoiding classic Java serialization from many reasons so you most likely want this on true! Also protocol will be almost certainly faster classic serialization!<br>
 	 * Note: This will only work when this converter is registered in {@link ParserRegistry} together with {@link SerializableBase64Converter}!
 	 * 
-	 * @since 1.0.0 (moved to {@link SerializableBase64Converter} since 1.3.0 and since 1.3.5 into {@link ObjectConverter})
+	 * @since 1.0.0 (moved to {@link SerializableBase64Converter} since 1.3.0 and since 1.3.5 into {@link ProtocolConverter})
 	 */
 	protected boolean useBase64IfCan = false;
 
@@ -95,7 +95,7 @@ public Object parse(ParserRegistry myHomeRegistry, String str, Object... compile
 	/**
 	 * @param myHomeRegistry | Same as {@link DataParser#parse(ParserRegistry, String, Object...)}.
 	 * @param objClass | Class of object to parse using {@link SerializationProtocol}.
-	 * @param str | String that starts with {@link Class} of object to deserialized (it will be used with {@link SerializationProtocol#unserializeObj(ProtocolRegistry, Class, Object...)}).
+	 * @param str | String that starts with {@link Class} of object to deserialized (it will be used with {@link SerializationProtocol#unserializeObj(ProtocolRegistry, long, Class, Object...)}).
 	 * @param compilerArgs | Same as {@link DataParser#parse(ParserRegistry, String, Object...)}.
 	 * 
 	 * @return Object od objClass parsed from str in accordance with compilerArgs!
@@ -108,7 +108,7 @@ protected Object parse(ParserRegistry myHomeRegistry, Class<?> objClass, String
 		{
 			StringBuilder sb = new StringBuilder(str);
 			sb.setCharAt(str.indexOf(' '), '=');
-			return myHomeRegistry.parse(sb.toString(), compilerArgs); //Should work only when ObjectConverter and VariableConverter are present...
+			return myHomeRegistry.parse(sb.toString(), compilerArgs); //Should work only when ProtocolConverter and VariableConverter are present...
 		}
 
 		if (compilerArgs.length < 5)
@@ -331,7 +331,7 @@ public Set<Class<?>> getInvokableClasses()
 	 * @param args | Parser args to get protocol from!
 	 * 
 	 * @return Protocol obtained from args or from {@link SerializationProtocol#REGISTRY} if there is no protocol or {@link ProtocolRegistry} in args (index 3).<br>
-	 * Note: This is mainly used by {@link ObjectConverter}!
+	 * Note: This is mainly used by {@link ProtocolConverter}!
 	 *
 	 * @since 1.3.5
 	 */
@@ -449,7 +449,7 @@ public static Object InvokeStaticFunc(Class<?> cls, Class<?> oldCls, String name
 	}
 
 	/**
-	 * Used internally by {@link ObjectConverter}!<br>
+	 * Used internally by {@link ProtocolConverter}!<br>
 	 * Dummy class with no purpose except to be mark (.class) for shortened scope expression such as:
 	 * <code>
 	 * shortenedSelectorLikeScope {<br><br>

SerialX-core/src/main/java/org/ugp/serialx/converters/SerializableBase64Converter.java

@@ -39,7 +39,7 @@ <td>new ArrayList()</td>
 		    <td>new int[] {5, 5, 5}</td>
 	  	</tr>
 	</table>
- * Note: In most of the cases {@link ObjectConverter} and {@link SerializationProtocol} should be used as preferable alternative!<br>
+ * Note: In most of the cases {@link SerializationProtocol} and therefore {@link ProtocolConverter} should be used as preferable alternative!<br>
  * Note: In order to avoid conflicts with JUSS syntax, this converter serializes and deserializes by using {@link Base64} and {@link URLEncoder} with addition of all % are being replaced by #!
  * 
  * @author PETO

SerialX-core/src/main/java/org/ugp/serialx/converters/StringConverter.java

@@ -4,10 +4,9 @@
 import static org.ugp.serialx.Utils.indexOfNotInObj;
 
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.Map;
 
-import org.ugp.serialx.Registry;
-
 /**
  * This converter is capable of converting {@link String}.
  * Its case sensitive!
@@ -30,7 +29,7 @@
 		    <td>new String("Hello world!")</td>
 	  	</tr>
 	</table>
- * If you enter string in ${yourString}, "yourString" will be returned by {@link StringConverter#toString(Registry, Object, Object...)} according to {@link StringConverter#CodeInsertion(String)}!
+ * If you enter string in ${yourString}, "yourString" will be returned by {@link StringConverter#toString} according to {@link StringConverter#DirectCode}!
  * 
  * @author PETO
  * 
@@ -155,9 +154,9 @@ public void setSerializeStringNormally(boolean serializeStringNormally)
 	}
 
 	/**
-	 * @param obj | Object to stringify directly.
+	 * @param obj | Object to stringify directly (without formating it as string).
 	 * 
-	 * @return "${" + obj + "}" - if this is be inserted into {@link StringConverter#toString(Registry, Object, Object...)}, it will be returned without ${ and }!
+	 * @return "${" + obj + "}" - if this is be inserted into {@link StringConverter#toString}, it will be returned without ${ and }!
 	 *
 	 * @since 1.3.5
 	 */

SerialX-core/src/main/java/org/ugp/serialx/converters/VariableParser.java

@@ -10,7 +10,7 @@
 
 /**
  * This parser is capable of reading variables from {@link GenericScope} by using <code>$</code>!<br>
- * {@link VariableParser#parse(String, Object...)} requires one additional Scope argument in args... at index 0!<br>
+ * {@link VariableParser#parse} requires one additional Scope argument in args... at index 0!<br>
  * It also manages access member operator also known as separator <code>"."</code>.<br>
  * Its case sensitive!<br>
  * Exact outputs of this converter are based on inserted scope!

SerialX-juss/src/main/java/org/ugp/serialx/juss/JussSerializer.java

@@ -192,7 +192,7 @@ public Imports getImports()
 	}
 
 	/**
-	 * @param absoluteClone | If true this scope will be cloned using {@link Serializer#Clone(Object, Registry, Object[], Object...)}, if false {@link Scope#clone()}!
+	 * @param absoluteClone | If true this scope will be cloned using {@link Utils#Clone}, if false {@link Scope#clone()}!
 	 * 
 	 * @return Clone of this scope!
 	 * 
@@ -622,7 +622,7 @@ else if (ch <= ' ') // Handle blanks, skip unnecessary
 	}
 
 	/**
-	 * @deprecated (1.3.9) DO NOT USE, IT IS SLOW AND POORLY WRITTEN, USE {@link JussSerializer#readAndParse(Collection, Reader, Object...)} INSTEAD!
+	 * @deprecated (1.3.9) DO NOT USE, IT IS SLOW AND POORLY WRITTEN, USE {@link JussSerializer#readAndParse(Collection, Reader, int, Object...)} INSTEAD!
 	 * 
 	 * @return Formated content of reader ready to parse! Should not modify this object in any way!
 	 * 
@@ -710,7 +710,7 @@ else if (ch == '}' || ch == ']')
 	}
 
 	/**
-	 * @deprecated (1.3.9) DO NOT USE, IT IS SLOW AND POORLY WRITTEN, USE {@link JussSerializer#readAndParse(Collection, Reader, Object...)} INSTEAD!
+	 * @deprecated (1.3.9) DO NOT USE, IT IS SLOW AND POORLY WRITTEN, USE {@link JussSerializer#readAndParse(Collection, Reader, int, Object...)} INSTEAD!
 	 * 
 	 * @return List of objects parsed from given formatted string!
 	 * 
@@ -791,9 +791,9 @@ else if (ch == '"')
 	/**
 	 * @return Object parsed from str!
 	 * <br><br>
-	 * Note: Used by {@link JussSerializer#splitAndParse(String, int, Object...)}!
+	 * Note: Used by {@link JussSerializer#readAndParse(Collection, Reader, int, Object...)}!
 	 * 
-	 * @see DataParser#parseObj(Registry, String, Object...)
+	 * @see ParserRegistry#parse(ParserRegistry, String, Object...)
 	 * 
 	 * @since 1.3.2
 	 */

SerialX-juss/src/main/java/org/ugp/serialx/juss/converters/VariableConverter.java

@@ -15,7 +15,7 @@
 
 /**
  * This converter is capable of converting {@link Map.Entry} and reading variables from {@link GenericScope} by using <code>$</code>!<br>
- * {@link VariableConverter#parse(String, Object...)} requires one additional Scope argument in args... at index 0!<br>
+ * {@link VariableConverter#parse} requires one additional Scope argument in args... at index 0!<br>
  * It manages assign operator <code>=</code> as well as access member operator also known as separator <code>"."</code>.<br>
  * Its case sensitive!<br>
  * Exact outputs of this converter are based on inserted scope!
@@ -38,7 +38,7 @@ public VariableConverter()
 
 	/**
 	 * @deprecated (1.3.9) IF YOU WANT THIS TO BE TRUE, YOU WANT TO USE <code>JsonVariableConverter</code> FROM <code>json-serializer</code> MODULE!
-	 * FORMATING IS NO DONE IN {@link VariableConverter#appendEntry(StringBuilder, CharSequence, Object, Object...)}
+	 * ORMATING IS NO DONE IN <code>toString</code> FUNCTION!
 	 * 
 	 * @param jsonStyle | If true, this converter will be using Json style of variables ("key" : value)!
 	 * 
@@ -188,7 +188,7 @@ public Object setMemberOperator(ParserRegistry myHomeRegistry, Object source, St
 
 	/**
 	 * @deprecated (1.3.9) IF YOU WANT THIS TO BE TRUE, YOU WANT TO USE <code>JsonVariableConverter</code> FROM <code>json-serializer</code> MODULE!
-	 * FORMATING IS NO DONE IN {@link VariableConverter#appendEntry(StringBuilder, CharSequence, Object, Object...)}
+	 * ORMATING IS NO DONE IN <code>toString</code> FUNCTION!
 	 * 
 	 * @return True if variables will be serialized using json style ("key" : value)!
 	 * 
@@ -202,7 +202,7 @@ public boolean isJsonStyle()
 
 	/**
 	 * @deprecated (1.3.9) IF YOU WANT THIS TO BE TRUE, YOU WANT TO USE <code>JsonVariableConverter</code> FROM <code>json-serializer</code> MODULE!
-	 * FORMATING IS NO DONE IN {@link VariableConverter#appendEntry(StringBuilder, CharSequence, Object, Object...)}
+	 * FORMATING IS NO DONE IN <code>toString</code> FUNCTION!
 	 * 
 	 * @param jsonStyle | If true, this converter will be using Json style of variables ("key" : value)!
 	 * 

SerialX-juss/src/main/java/org/ugp/serialx/juss/protocols/SelfSerializableProtocol.java

@@ -15,7 +15,7 @@ public class SelfSerializableProtocol<T extends SelfSerializable> extends Univer
 {
 	/**
 	 * @param applicableFor | Class implementing {@link SelfSerializable} that can be serialized using this protocol.<br>
-	 * Note: Passing {@link SelfSerializable#getClass()} will make this protocol universal and work for any {@link SelfSerializable} instance, this can be considered unsafe in some cases...
+	 * Note: Passing <code>{@link SelfSerializable}.class</code> will make this protocol universal and work for any {@link SelfSerializable} instance, this can be considered a security risk in some cases...
 	 * 
 	 * @since 1.3.8
 	 */

SerialX-operators/src/main/java/org/ugp/serialx/converters/operators/ArithmeticOperators.java

@@ -23,7 +23,7 @@
 public class ArithmeticOperators implements DataParser
 {
 	/**
-	 * Operator characters recognized by {@link ArithmeticOperators}, operators can be any combination of provided characters. Exact behavior is handled by {@link ArithmeticOperators#operator(Object, String, Object)}.<br> Intended for override, should not be null or empty!
+	 * Operator characters recognized by {@link ArithmeticOperators}, operators can be any combination of provided characters. Exact behavior is handled by {@link ArithmeticOperators#operator}.<br> Intended for override, should not be null or empty!
 	 * 
 	 * @since 1.3.8
 	 */