Documentation updated

New Features:
• None

Author: shaileshmishra

CHANGELOG.md

@@ -1,6 +1,12 @@
 
 ## CHANGELOG
 
+## Version 1.5.6
+###### Date: 27-Jan-2021
+Document updated 
+
+New Features:
+• None
 
 ## Version 1.5.5
 ###### Date: 22-Jan-2021

README.md

@@ -20,13 +20,13 @@ To use the Contentstack Java SDK to your existing project, perform the steps giv
 <dependency>
   <groupId>com.contentstack.sdk</groupId>
   <artifactId>java</artifactId>
-  <version>1.5.5</version>
+  <version>1.5.6</version>
 </dependency>
 ```
 
 2. **Gradle**
 ```
-implementation 'com.contentstack.sdk:java:1.5.5'
+implementation 'com.contentstack.sdk:java:1.5.6'
 ```
 
 ### Key Concepts for using Contentstack

pom.xml

@@ -6,7 +6,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>1.5.5</version>
+    <version>1.5.6</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API, Contentstack is a headless CMS with an API-first approach
@@ -291,6 +291,7 @@
                         <goals>
                             <goal>report</goal>
                         </goals>
+
                     </execution>
                 </executions>
             </plugin>

src/main/java/com/contentstack/sdk/AssetLibrary.java

@@ -12,7 +12,6 @@ Assets refer to all the media files (images, videos, PDFs, audio files, and so o
  These files can be used in multiple entries.
  Read more about [Assets](https://www.contentstack.com/docs/guide/content-management#working-with-assets)
  */
-
 public class AssetLibrary implements INotifyClass{
 
     private com.contentstack.sdk.Stack stackInstance;
@@ -27,7 +26,6 @@ public class AssetLibrary implements INotifyClass{
      * Sorting order enum for {@link AssetLibrary}.
      * @author Contentstack.com, Inc
      */
-
     public enum ORDERBY
     {
         ASCENDING,
@@ -60,7 +58,6 @@ protected void setStackInstance(Stack stack){
      * assetLibObject.setHeader("custom_header_key", "custom_header_value");
      * </pre>
      */
-
     public void setHeader(String key, String value) {
         if (!key.isEmpty() && !value.isEmpty()) {
             localHeader.put(key, value);

src/main/java/com/contentstack/sdk/Stack.java

@@ -60,10 +60,10 @@ protected Stack(String stackApiKey) {
     }
 
     protected void setConfig(Config config){
-        this.config        = config;
-        URLSCHEMA          = config.URLSCHEMA;
-        URL                = config.URL;
-        VERSION            = config.VERSION;
+        this.config       = config;
+        URLSCHEMA    = config.URLSCHEMA;
+        URL               = config.URL;
+        VERSION         = config.VERSION;
 
         if(!config.environment.isEmpty()){
             setHeader("environment", config.environment);
@@ -90,8 +90,11 @@ public ContentType contentType(String contentTypeName){
     }
 
 
-
-
+    /**
+     * Takes asset uid as a parameter and returns @{@link Asset} instance
+     * @param uid uid of {@link Asset}
+     * @return Asset instance
+     */
     public Asset asset(String uid){
         Asset asset = new Asset(uid);
         asset.setStackInstance(this);
@@ -106,33 +109,55 @@ protected Asset asset(){
         return asset;
     }
 
-
-
+    /**
+     * assetLibrary returns AssetLibrary instance
+     * @return @{@link AssetLibrary}
+     */
     public AssetLibrary assetLibrary(){
         AssetLibrary library = new AssetLibrary();
         library.setStackInstance(this);
-
         return library;
     }
 
 
-
+    /**
+     * Returns apiKey of particular stack
+     * @return @{@link String} stack api key
+     */
     public String getApplicationKey(){ return stackApiKey;}
 
 
-
+    /**
+     * Returns accessToken of particular stack
+     * @return @{@link String} access token of particular stack
+     */
     public String getAccessToken(){ return localHeader != null ? (String)localHeader.get("access_token") : null;};
 
 
-
+    /**
+     * Removes Header by key
+     * @param key @{@link String} header key
+     * <br><br><b>Example :</b><br>
+     *  stack.removeHeader("delivery_token");
+     * <br><br>
+     * </p>
+     */
     public void removeHeader(String key){
         if(!key.isEmpty()){
             localHeader.remove(key);
         }
     }
 
 
-
+    /**
+     * Adds header to the stack by key and value
+     * @param key @{@link String} header key
+     * @param value @{@link String} header value
+     *  <p>
+     *              Example
+     *              stack.setHeader("delivery_token","blt843748744");
+     *  </p>
+     */
     public void setHeader(String key, String value) {
         if (!key.isEmpty() && !value.isEmpty()) {
             localHeader.put(key, value);

src/main/java/com/contentstack/sdk/utility/CSAppConstants.java

@@ -6,7 +6,7 @@
 
 public class CSAppConstants {
 
-    public static final String SDK_VERSION = "1.5.5";
+    public static final String SDK_VERSION = "1.5.6";
 
     public static enum RequestMethod
     {