Merge pull request #56 from sjsajj/fixJavaDocWarning

Fixing java doc warnings.

Author: julman99

src/main/java/io/gsonfire/ClassConfig.java

@@ -4,7 +4,7 @@
 import java.util.Collection;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public final class ClassConfig<T> {
 

src/main/java/io/gsonfire/DateSerializationPolicy.java

@@ -10,7 +10,7 @@
 import java.util.TimeZone;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public enum DateSerializationPolicy {
 

src/main/java/io/gsonfire/GsonFireBuilder.java

@@ -15,7 +15,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public final class GsonFireBuilder {
 
@@ -59,10 +59,10 @@ private static void insertOrdered(List<Class> classes, Class clazz) {
      * A type selector is in charge of deciding which sub class to use when converting a json
      * into an object.<br />
      * See <a href="http://goo.gl/qKo7z"> docs and example</a>
-     * @param clazz
-     * @param factory
-     * @param <T>
-     * @return
+     * @param clazz class
+     * @param factory factory
+     * @param <T> type selector
+     * @return a GsonFireBuilder
      */
     public <T> GsonFireBuilder registerTypeSelector(Class<T> clazz, TypeSelector<T> factory){
         ClassConfig config = getClassConfig(clazz);
@@ -76,10 +76,10 @@ public <T> GsonFireBuilder registerTypeSelector(Class<T> clazz, TypeSelector<T>
      * will prepare a class just created from a json.<br />
      * See <a href="http://goo.gl/5fLLN"> docs and example</a>
      *
-     * @param clazz
-     * @param postProcessor
-     * @param <T>
-     * @return
+     * @param clazz class
+     * @param postProcessor post processor
+     * @param <T> type
+     * @return GsonFireBuilder
      */
     public <T> GsonFireBuilder registerPostProcessor(Class<T> clazz, PostProcessor<? super T> postProcessor){
         ClassConfig config = getClassConfig(clazz);
@@ -93,10 +93,10 @@ public <T> GsonFireBuilder registerPostProcessor(Class<T> clazz, PostProcessor<?
      * it actually gets deserialized into a class
      * See <a href="http://goo.gl/b8V1AA"> docs and example</a>
      *
-     * @param clazz
-     * @param preProcessor
-     * @param <T>
-     * @return
+     * @param clazz class
+     * @param preProcessor pre processor
+     * @param <T> type
+     * @return GsonFireBuilder
      */
     public <T> GsonFireBuilder registerPreProcessor(Class<T> clazz, PreProcessor<? super T> preProcessor){
         ClassConfig config = getClassConfig(clazz);
@@ -106,8 +106,8 @@ public <T> GsonFireBuilder registerPreProcessor(Class<T> clazz, PreProcessor<? s
 
     /**
      * Configures the resulting Gson to serialize/unserialize Date instances with a policy
-     * @param policy
-     * @return
+     * @param policy serialization policy
+     * @return GsonFireBuilder
      */
     public GsonFireBuilder dateSerializationPolicy(DateSerializationPolicy policy){
         dateSerializationPolicy = policy;
@@ -118,9 +118,9 @@ public GsonFireBuilder dateSerializationPolicy(DateSerializationPolicy policy){
      * A given class will be wrapped/unwrapped with a given string
      * during serialization/deserialization.
      *
-     * @param clazz
-     * @param <T>
-     * @return
+     * @param clazz class
+     * @param <T> type
+     * @return GsonFireBuilder
      */
     public <T> GsonFireBuilder wrap(final Class<T> clazz, final String name) {
         wrap(clazz, new Mapper<T, String>() {
@@ -136,10 +136,10 @@ public String map(Object from) {
      * A given class will be wrapped/unwrapped with a string generated by a mapper
      * during serialization/deserialization.
      *
-     * @param clazz
-     * @param mapper
-     * @param <T>
-     * @return
+     * @param clazz class
+     * @param mapper mapper
+     * @param <T> type
+     * @return GsonFireBuilder
      */
     public <T> GsonFireBuilder wrap(Class<T> clazz, Mapper<T, String> mapper) {
         wrappedClasses.put(clazz, mapper);
@@ -149,7 +149,7 @@ public <T> GsonFireBuilder wrap(Class<T> clazz, Mapper<T, String> mapper) {
     /**
      * By enabling this, all methods with the annotation {@link io.gsonfire.annotations.ExposeMethodResult} will
      * be evaluated and it result will be added to the resulting json
-     * @return
+     * @return GsonFireBuilder
      */
     public GsonFireBuilder enableExposeMethodResult(){
         this.enableExposeMethodResults = true;
@@ -159,7 +159,7 @@ public GsonFireBuilder enableExposeMethodResult(){
     /**
      * By enabling this, all exclusion by value strategies specified with the annotation
      * {@link io.gsonfire.annotations.ExcludeByValue} will be run to remove specific fields from the resulting json
-     * @return
+     * @return GsonFireBuilder
      */
     public GsonFireBuilder enableExclusionByValue(){
         this.enableExclusionByValueStrategies = true;
@@ -169,7 +169,7 @@ public GsonFireBuilder enableExclusionByValue(){
     /**
      * By enabling this, all methods with the annotation {@link io.gsonfire.annotations.ExposeMethodResult} will
      * be evaluated and it result will be added to the resulting json
-     * @return
+     * @return GsonFireBuilder
      */
     public GsonFireBuilder enableHooks(Class clazz){
         ClassConfig config = getClassConfig(clazz);
@@ -183,7 +183,7 @@ public GsonFireBuilder enableHooks(Class clazz){
      * with the resulting json object.
      *
      * This method has been deprecated and a {@link io.gsonfire.PostProcessor} should be used instead
-     * @return
+     * @return GsonFireBuilder
      */
     @Deprecated
     public GsonFireBuilder enableMergeMaps(Class clazz){
@@ -194,8 +194,8 @@ public GsonFireBuilder enableMergeMaps(Class clazz){
     /**
      * Sets the serialization TimeZone. This will affect only values that depend on the TimeZone, for example rfc3339
      * dates.
-     * @param timeZone
-     * @return
+     * @param timeZone time zone
+     * @return GsonFireBuilder
      */
     public GsonFireBuilder serializeTimeZone(TimeZone timeZone) {
         this.serializeTimeZone = timeZone;
@@ -205,10 +205,10 @@ public GsonFireBuilder serializeTimeZone(TimeZone timeZone) {
     /**
      * Defines a default value for an enum when its String representation does not match any of the enum values.
      * The <code>defaultValue</code> can be null.
-     * @param enumClass
-     * @param defaultValue
-     * @param <T>
-     * @return
+     * @param enumClass enum class
+     * @param defaultValue default value
+     * @param <T> type
+     * @return GsonFireBuilder
      */
     public <T extends Enum> GsonFireBuilder enumDefaultValue(Class<T> enumClass, T defaultValue) {
         this.enumDefaultValues.put(enumClass, defaultValue);
@@ -222,7 +222,7 @@ public GsonFireBuilder addSerializationExclusionStrategy(FireExclusionStrategy e
 
     /**
      * Returns a new instance of the good old {@link GsonBuilder}
-     * @return
+     * @return a new instance of the good old {@link GsonBuilder}
      */
     public GsonBuilder createGsonBuilder(){
         Set<TypeToken> alreadyResolvedTypeTokensRegistry = Collections.newSetFromMap(new ConcurrentHashMap<TypeToken, Boolean>());
@@ -261,7 +261,7 @@ public GsonBuilder createGsonBuilder(){
 
     /**
      * Returns a new {@link Gson} instance
-     * @return
+     * @return a new {@link Gson} instance
      */
     public Gson createGson(){
         return createGsonBuilder().create();

src/main/java/io/gsonfire/PostProcessor.java

@@ -4,7 +4,7 @@
 import com.google.gson.JsonElement;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public interface PostProcessor<T> {
 

src/main/java/io/gsonfire/PreProcessor.java

@@ -4,7 +4,7 @@
 import com.google.gson.JsonElement;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public interface PreProcessor<T> {
 

src/main/java/io/gsonfire/TypeSelector.java

@@ -3,7 +3,7 @@
 import com.google.gson.JsonElement;
 
 /**
- * @autor: julio
+ * @author julio
  */
 public interface TypeSelector<T> {
 

src/main/java/io/gsonfire/annotations/ExposeMethodResult.java

@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * @autor: julio
+ * @author julio
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)

src/main/java/io/gsonfire/annotations/MergeMap.java

@@ -9,7 +9,7 @@
  * Causes the Map to be merged with the object that contains it
  *
  * This class has been deprecated and a {@link io.gsonfire.PostProcessor} should be used instead
- * @autor: julio
+ * @author julio
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)

src/main/java/io/gsonfire/annotations/PostDeserialize.java

@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * @autor: julio
+ * @author julio
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)

src/main/java/io/gsonfire/annotations/PreSerialize.java

@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * @autor: julio
+ * @author julio
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)