Fixed various javadoc related warning

Author: iamhssingh

drfapi/src/main/java/com/civilmachines/drfapi/DefaultAPIErrorListener.java

@@ -4,23 +4,24 @@
 
 
 /**
- * A class that implements all abstract method of DjangoErrorListener via a
- * blank body.
+ * A class that implements all abstract method of DjangoErrorListener with blank
+ * function body. It requires user to override and implement the same in activity
+ * where Django Request is being created. This way, user has access to all activity/
+ * context based variables.
  *
  * Programmer is expected to use this in a following manner:
- * <pre>
- *     {@code
- *     new DefaultAPIErrorListener() {
- *          @Override
- *          public void onNetworkError(String response){
- *              // Do something
- *              // Use variable present in activity/class such as alert dialog etc.
- *          }
- *     }
- *     }
- * </pre>
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ *
+ * <pre>{@code
+ *     new DefaultAPIErrorListener(){
+ *         public void onNetworkError(String response){
+ *             // Do something
+ *             // Use variable present in activity/class such as alert dialog etc.
+ *         }
+ *     };
+ * }</pre>
+ *
+ * @author <a href=https://himanshus.com target=_blank>Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public class DefaultAPIErrorListener extends DjangoErrorListener {
 

drfapi/src/main/java/com/civilmachines/drfapi/DjangoBaseRequest.java

@@ -34,8 +34,8 @@
  *
  * @param <T> specifies the format in which response will come
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public abstract class DjangoBaseRequest<T> extends JsonRequest<T> {
 
@@ -58,8 +58,6 @@ public abstract class DjangoBaseRequest<T> extends JsonRequest<T> {
      * @param errorListener Error listener, or null to ignore errors.
      * @param context Context for accessing SharedPreference (used in headers)
      *
-     * @author Himanshu Shankar (https://himanshus.com)
-     * @author Divya Tiwari (https://divyatiwari.me)
      */
     public DjangoBaseRequest(int method,
                              String url,
@@ -78,7 +76,6 @@ public DjangoBaseRequest(int method,
      * Sets Content-Type to application/json
      * Checks for presence of token in SharedPreferenceAdapter and sets it.
      * @return Map a Map of headers
-     * @author Himanshu Shankar (https://himanshus.com)
      */
     @Override
     public Map<String, String> getHeaders() {

drfapi/src/main/java/com/civilmachines/drfapi/DjangoErrorListener.java

@@ -30,16 +30,16 @@
 import org.json.JSONObject;
 
 /**
- * An abstract class that implements {@link Response.ErrorListener} and handles
+ * An abstract class that implements {@link com.android.volley.Response.ErrorListener} and handles
  * error commonly raised by Django REST Framework based REST APIs.
  *
  * This class has 18 abstract functions that are required to be implemented.
  *
  * onErrorResponse function parses an error from API and invokes appropriate
  * function.
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwar (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public abstract class DjangoErrorListener implements Response.ErrorListener {
 

drfapi/src/main/java/com/civilmachines/drfapi/DjangoJSONArrayResponseRequest.java

@@ -36,8 +36,8 @@
  * Creates request on Django APIs where response is in JSONArray format while request is in
  * JSONObject format
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public class DjangoJSONArrayResponseRequest extends DjangoBaseRequest<JSONArray> {
     /**
@@ -52,8 +52,6 @@ public class DjangoJSONArrayResponseRequest extends DjangoBaseRequest<JSONArray>
      * @param errorListener Error listener, or null to ignore errors.
      * @param context A {@link Activity} to handle create {@link SharedPreferenceAdapter} object for token.
      *
-     * @author Himanshu Shankar (https://himanshus.com)
-     * @author Divya Tiwari (https://divyatiwari.me)
      */
     public DjangoJSONArrayResponseRequest(int method,
                                           String url,
@@ -78,7 +76,6 @@ public DjangoJSONArrayResponseRequest(int method,
      * @param errorListener error listener (must implement {@link DjangoErrorListener}
      * @param context context for accessing SharedPreference
      *
-     * @author Himanshu Shankar (https://himanshus.com)
      */
     public DjangoJSONArrayResponseRequest(String url,
                                           @Nullable JSONObject jsonRequest,
@@ -97,8 +94,6 @@ public DjangoJSONArrayResponseRequest(String url,
      * @return Response.success with JSONArray format of response or
      *         Response.error when response in non-JSONArray format
      *
-     * @author Himanshu Shankar (https://himanshus.com)
-     * @author Divya Tiwari (https://divyatiwari.me)
      */
     @Override
     protected Response<JSONArray> parseNetworkResponse(NetworkResponse response) {

drfapi/src/main/java/com/civilmachines/drfapi/DjangoJSONObjectRequest.java

@@ -36,8 +36,8 @@
  * Creates request on Django APIs where response is in JSONObject format and request is also in
  * JSONObject format
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public class DjangoJSONObjectRequest extends DjangoBaseRequest<JSONObject> {
 
@@ -53,8 +53,6 @@ public class DjangoJSONObjectRequest extends DjangoBaseRequest<JSONObject> {
      * @param errorListener Error listener, or null to ignore errors.
      * @param context A {@link Activity} to handle create {@link SharedPreferenceAdapter} object for token.
      *
-     * @author Himanshu Shankar (https://himanshus.com)
-     * @author Divya Tiwari (https://divyatiwari.me)
      */
     public DjangoJSONObjectRequest(int method,
                                    String url,
@@ -77,7 +75,6 @@ public DjangoJSONObjectRequest(int method,
      * @param errorListener error listener (must implement {@link DjangoErrorListener}
      * @param context context for accessing SharedPreference
      *
-     * @author Himanshu Shankar (https://himanshus.com)
      */
     public DjangoJSONObjectRequest(String url,
                                    @Nullable JSONObject jsonRequest,
@@ -96,8 +93,6 @@ public DjangoJSONObjectRequest(String url,
      * @return Response.success with JSONObject format of response or
      *         Response.error when response in non-JSONObject format
      *
-     * @author Himanshu Shankar (https://himanshus.com)
-     * @author Divya Tiwari (https://divyatiwari.me)
      */
     @Override
     protected Response<JSONObject> parseNetworkResponse(NetworkResponse response) {

drfapi/src/main/java/com/civilmachines/drfapi/SharedPreferenceAdapter.java

@@ -30,8 +30,8 @@
 /**
  * An adapter to handle Shared Preference in a uniform manner
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public class SharedPreferenceAdapter {
 

drfapi/src/main/java/com/civilmachines/drfapi/UserSharedPreferenceAdapter.java

@@ -16,8 +16,8 @@
  *     UserSharedPreferenceAdapter.keyToken = "userToken";
  * </pre>
  *
- * @author Himanshu Shankar (https://himanshus.com)
- * @author Divya Tiwari (https://divyatiwari.me)
+ * @author <a href="https://himanshus.com" target="_blank">Himanshu Shankar</a>
+ * @author <a href="https://divyatiwari.me" target="_blank">Divya Tiwari</a>
  */
 public class UserSharedPreferenceAdapter extends SharedPreferenceAdapter {
     public static String userPrivate = "user_private";