docs cleanup 🎉

Author: ishaileshmishra

src/main/java/com/contentstack/cms/Contentstack.java

@@ -1,20 +1,20 @@
 package com.contentstack.cms;
 
 import com.contentstack.cms.core.AuthInterceptor;
-import com.contentstack.cms.models.Error;
 import com.contentstack.cms.core.Util;
+import com.contentstack.cms.models.Error;
 import com.contentstack.cms.models.LoginDetails;
 import com.contentstack.cms.organization.Organization;
 import com.contentstack.cms.stack.Stack;
 import com.contentstack.cms.user.User;
 import com.google.gson.Gson;
 import okhttp3.OkHttpClient;
 import okhttp3.ResponseBody;
+import okhttp3.logging.HttpLoggingInterceptor;
 import org.jetbrains.annotations.NotNull;
 import retrofit2.Response;
 import retrofit2.Retrofit;
 import retrofit2.converter.gson.GsonConverterFactory;
-import okhttp3.logging.HttpLoggingInterceptor;
 
 import java.io.IOException;
 import java.net.Proxy;
@@ -25,7 +25,12 @@
 import static com.contentstack.cms.core.Util.*;
 
 /**
- * The type Contentstack.
+ * <b>Contentstack Java Management SDK</b>
+ * <br>
+ * <b>Contentstack Java Management SDK</b> interact with the Content Management APIs and allow you to create, update,
+ * delete, and fetch content from your Contentstack account. They are read-write in nature.
+ * <b>
+ * You can use them to build your own apps and manage your content from Contentstack.
  */
 public class Contentstack {
 
@@ -63,7 +68,11 @@ public class Contentstack {
      * </pre>
      * <br>
      *
-     * @return User user
+     * @return User
+     * @author ishaileshmishra
+     * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#users">User
+     * </a>
+     * @since 2022-05-19
      */
     public User user() {
         if (this.authtoken == null)
@@ -103,12 +112,15 @@ public User user() {
      * <br>
      *
      * @param emailId
-     *         the email id
+     *         the email id of the user
      * @param password
-     *         the password
-     * @return response the Response type of @{@link LoginDetails}
+     *         the password of the user
+     * @return LoginDetails
      * @throws IOException
-     *         the io exception
+     *         the IOException
+     * @author ishaileshmishra
+     * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#users">User
+     * </a>
      */
     public Response<LoginDetails> login(String emailId, String password) throws IOException {
         if (this.authtoken != null)
@@ -155,9 +167,16 @@ public Response<LoginDetails> login(String emailId, String password) throws IOEx
      *         the password
      * @param tfaToken
      *         the tfa token
-     * @return response the Response type of @{@link LoginDetails} throws {@link IOException}
+     * @return LoginDetails
      * @throws IOException
      *         the io exception
+     * @throws IOException
+     *         the IOException
+     * @author ishaileshmishra
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#log-in-to-your-account">Login
+     * your account
+     * </a>
      */
     public Response<LoginDetails> login(String emailId, String password, String tfaToken) throws IOException {
         if (this.authtoken != null)
@@ -400,9 +419,12 @@ public Builder() {
          * InetSocketAddress(proxyHost, proxyPort));
          * <br>
          * <pre>
-         *         Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
-         *         Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
-         *     </pre>
+         * {
+         * @code
+         * Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
+         * Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
+         * }
+         * </pre>
          *
          * @param proxy
          *         the proxy

src/main/java/com/contentstack/cms/core/AuthInterceptor.java

@@ -15,7 +15,7 @@
  * responses coming back in. Typically, interceptors add, remove, or transform headers on the request. Depending on the
  * API implementation, you'll want to pass the auth token as the value for the Authorization header.
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/CMSLogger.java

@@ -7,7 +7,7 @@
 /**
  * The Contentstack Logger
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/CMSRuntimeException.java

@@ -3,7 +3,7 @@
 /**
  * CMSRuntimeException that extends Exception class
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/CSResponse.java

@@ -9,6 +9,14 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * Contentstack Response:
+ *
+ * @author ishaileshmishra
+ * @version 1.0.0
+ * @since 2022-05-19
+ */
+
 public class CSResponse {
 
     private static final String MODEL_NULL_CHECK = "model class == null";

src/main/java/com/contentstack/cms/core/Callback.java

@@ -3,7 +3,7 @@
 /**
  * The Callback for the contentstack response
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/ContentstackResponse.java

@@ -11,7 +11,7 @@
  * The ContentstackResponse is the response when we execute the API Response, ContentstackResponse contains different
  * response type
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/ResponseResult.java

@@ -11,7 +11,7 @@
 /**
  * The Contentstack ResponseResult class that accepts different types of Models
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/RetryCallback.java

@@ -9,7 +9,7 @@
 /**
  * The Contentstack RetryCallback
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */

src/main/java/com/contentstack/cms/core/Util.java

@@ -10,7 +10,7 @@
 /**
  * The utility class that contains utility common functions
  *
- * @author Shailesh Mishra
+ * @author ishaileshmishra
  * @version 1.0.0
  * @since 2022-05-19
  */