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 ***REMOVED***
+     * @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 ***REMOVED***
+     * @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 ***REMOVED***
+     * @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/CSResponse.java

@@ -9,6 +9,14 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * Contentstack Response:
+ *
+ * @author ***REMOVED***
+ * @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/user/User.java

@@ -13,11 +13,12 @@
 import java.util.Map;
 
 /**
- * The type User.
- */
-/*
- * All accounts registered with Contentstack are known as Users. A stack can
- * have many users with varying permissions and roles.
+ * All accounts registered with Contentstack are known as Users. A stack can have many users with varying permissions
+ * and roles.
+ *
+ * @author ***REMOVED***
+ * @version 1.0.0
+ * @since 2022-05-19
  */
 public class User {
 
@@ -27,20 +28,19 @@ public class User {
      * Instantiates a new User.
      *
      * @param client
-     *               the client
+     *         the client
      */
     public User(Retrofit client) {
         this.userService = client.create(UserService.class);
     }
 
     /**
-     * The Log in to your account request is used to sign in to your Contentstack
-     * account and obtain the authtoken.
+     * The Log in to your account request is used to sign in to your Contentstack account and obtain the authtoken.
      *
      * @param emailId
-     *                 the email id
+     *         the email id
      * @param password
-     *                 the password
+     *         the password
      * @return the call
      */
     public Call<LoginDetails> login(@NotNull String emailId, @NotNull String password) {
@@ -55,11 +55,11 @@ public Call<LoginDetails> login(@NotNull String emailId, @NotNull String passwor
      * Login call.
      *
      * @param emailId
-     *                 the email id
+     *         the email id
      * @param password
-     *                 the password
+     *         the password
      * @param tfaToken
-     *                 the tfa token
+     *         the tfa token
      * @return the call
      */
     public Call<LoginDetails> login(@NotNull String emailId, @NotNull String password, @NotNull String tfaToken) {
@@ -81,10 +81,8 @@ private HashMap<String, String> setCredentials(@NotNull String... arguments) {
     }
 
     /**
-     * The Get user call returns comprehensive information of an existing user
-     * account. The information returned
-     * includes details of the stacks owned by and shared with the specified user
-     * account. <br>
+     * The Get user call returns comprehensive information of an existing user account. The information returned
+     * includes details of the stacks owned by and shared with the specified user account. <br>
      *
      * @return {@link UserService}
      */
@@ -94,30 +92,25 @@ public Call<ResponseBody> getUser() {
 
 
     /**
-     * The Get user call returns comprehensive information of an existing user
-     * account. The information returned
-     * includes details of the stacks and organisation owned by and shared with the
-     * specified user account.
+     * The Get user call returns comprehensive information of an existing user account. The information returned
+     * includes details of the stacks and organisation owned by and shared with the specified user account.
      *
      * @param query
-     *              parameters
+     *         parameters
      * @return {@link UserService}
      */
     public Call<ResponseBody> getUserOrganizations(@NotNull Map<String, Object> query) {
         return this.userService.getUserOrganization(query);
     }
 
     /**
-     * The Update User API Request updates the details of an existing user account.
-     * Only the information entered here
-     * will be updated, the existing data will remain unaffected. <br>
-     * When executing the API call, under the 'Body'
-     * section, enter the information of the user that you wish to update. This
-     * information should be in JSON format.
+     * The Update User API Request updates the details of an existing user account. Only the information entered here
+     * will be updated, the existing data will remain unaffected. <br> When executing the API call, under the 'Body'
+     * section, enter the information of the user that you wish to update. This information should be in JSON format.
      * <br>
      *
      * @param strBody
-     *                the str body
+     *         the str body
      * @return {@link UserService}
      */
     public Call<ResponseBody> updateUser(String strBody) {
@@ -131,69 +124,61 @@ private RequestBody toBody(String bodyString) {
     }
 
     /**
-     * The activate_token a user account call activates the account of a user after
-     * signing up. For account activation,
+     * The activate_token a user account call activates the account of a user after signing up. For account activation,
      * you will require the token received in the activation email. <br>
      *
      * @param activationToken
-     *                        The activation token
+     *         The activation token
      * @param requestBody
-     *                        The request body
+     *         The request body
      * @return {@link UserService}
      */
     public Call<ResponseBody> activateUser(@NotNull String activationToken, String requestBody) {
         return userService.activateUser(activationToken, toBody(requestBody));
     }
 
     /**
-     * The Request for a password call sends a request for a temporary password to
-     * log in to an account in case a user
-     * has forgotten the login password. <br>
-     * Using this temporary password, you can log in to your account and set a
+     * The Request for a password call sends a request for a temporary password to log in to an account in case a user
+     * has forgotten the login password. <br> Using this temporary password, you can log in to your account and set a
      * new password for your Contentstack account. <br>
      * <ul>
      * <li>Provide the user's email address in JSON format</li>
      * </ul>
      *
      * @param requestBody
-     *                    the request body
+     *         the request body
      * @return {@link UserService}
      */
     public Call<ResponseBody> requestPassword(String requestBody) {
         return userService.requestPassword(toBody(requestBody));
     }
 
     /**
-     * The Reset password call sends a request for resetting the password of your
-     * Contentstack account. <br>
-     * When
-     * executing the call, in the 'Body' section, you need to provide the token that
-     * you receive via email, your new
+     * The Reset password call sends a request for resetting the password of your Contentstack account. <br> When
+     * executing the call, in the 'Body' section, you need to provide the token that you receive via email, your new
      * password, and password confirmation in JSON format. <br>
      *
      * @param requestBody
-     *                    the request body
+     *         the request body
      * @return {@link UserService}
      */
     public Call<ResponseBody> resetPassword(@NotNull String requestBody) {
         return userService.resetPassword(toBody(requestBody));
     }
 
     /**
-     * The Log out of your account call is used to sign out the user of Contentstack
-     * account
+     * The Log out of your account call is used to sign out the user of Contentstack account
      *
      * @param authtoken
-     *                  : authtoken
+     *         : authtoken
      * @return {@link UserService}
      */
     public Call<ResponseBody> logoutWithAuthtoken(String authtoken) {
         return userService.logout(authtoken);
     }
 
     /**
-     * The Log out of your account call is used to sign out the user of Contentstack
-     * account
+     * The Log out of your account call is used to sign out the user of Contentstack account
      *
      * @return {@link UserService}
      */