💡 Documenting source code

Author: shaileshmishra

src/main/java/com/contentstack/gqlspring/GQL.java

@@ -12,6 +12,9 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * The type Gql.
+ */
 final class GQL {
 
     private final int id;
@@ -21,6 +24,11 @@ final class GQL {
     private final JSONObject queryJson;
     private final HttpHeaders headers;
 
+    /**
+     * Instantiates a new Gql.
+     *
+     * @param builder the builder
+     */
     public GQL(Builder builder) {
         this.id = builder.id;
         this.tag = builder.tag;
@@ -42,6 +50,12 @@ public String toString() {
                 '}';
     }
 
+    /**
+     * Fetch json node.
+     *
+     * @return the json node
+     * @throws JsonProcessingException the json processing exception
+     */
     public JsonNode fetch() throws JsonProcessingException {
         RestTemplate restTemplate = new RestTemplate();
         HttpEntity<JSONObject> entity = new HttpEntity<JSONObject>(queryJson, this.headers);
@@ -58,6 +72,12 @@ public JsonNode fetch() throws JsonProcessingException {
         }
     }
 
+    /**
+     * Model it.
+     *
+     * @param <T>            the type parameter
+     * @param responseString the response string
+     */
     public <T> void modelIt(String responseString) {
         try {
             ObjectMapper mapper = new ObjectMapper();
@@ -72,6 +92,9 @@ public <T> void modelIt(String responseString) {
         }
     }
 
+    /**
+     * The type Builder.
+     */
     public static class Builder {
 
         private int id;
@@ -84,20 +107,43 @@ public static class Builder {
         private Builder() {
         }
 
+        /**
+         * New instance builder.
+         *
+         * @return the builder
+         */
         public static Builder newInstance() {
             return new Builder();
         }
 
+        /**
+         * Sets id.
+         *
+         * @param id the id
+         * @return the id
+         */
         public Builder setId(int id) {
             this.id = id;
             return this;
         }
 
+        /**
+         * Sets tag.
+         *
+         * @param tag the tag
+         * @return the tag
+         */
         public Builder setTag(String tag) {
             this.tag = tag;
             return this;
         }
 
+        /**
+         * Sets node.
+         *
+         * @param node the node
+         * @return the node
+         */
         public Builder setNode(String node) {
             if (node != null && !node.isEmpty()) {
                 this.nodeSplitter = node.split(":");
@@ -109,18 +155,36 @@ public Builder setNode(String node) {
             return this;
         }
 
+        /**
+         * Sets url.
+         *
+         * @param url the url
+         * @return the url
+         */
         public Builder setUrl(String url) {
             this.url = url;
             return this;
         }
 
+        /**
+         * Sets query string.
+         *
+         * @param queryString the query string
+         * @return the query string
+         */
         public Builder setQueryString(String queryString) {
             JSONObject jsonObject = new JSONObject();
             jsonObject.appendField("query", queryString);
             this.queryJson = jsonObject;
             return this;
         }
 
+        /**
+         * Sets header.
+         *
+         * @param access_token the access token
+         * @return the header
+         */
         public Builder setHeader(String access_token) {
             final HttpHeaders headers = new HttpHeaders();
             ArrayList<MediaType> acceptableMediaTypes = new ArrayList<MediaType>();
@@ -131,6 +195,11 @@ public Builder setHeader(String access_token) {
             return this;
         }
 
+        /**
+         * Build gql.
+         *
+         * @return the gql
+         */
         public GQL build() {
             // Do some validation part if required values are not provided
             // if (url.isEmpty()){

src/main/java/com/contentstack/gqlspring/GQLTestApplication.java

@@ -11,18 +11,32 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * The type Gql test application.
+ */
 @SpringBootApplication
 @RestController
 @Slf4j
 @Validated
 @RequestMapping(path = "api")
 public class GQLTestApplication {
 
+    /**
+     * The entry point of application.
+     *
+     * @param args the input arguments
+     */
     public static void main(String[] args) {
         SpringApplication.run(GQLTestApplication.class, args);
     }
 
 
+    /**
+     * Gets products.
+     *
+     * @return the products
+     * @throws JsonProcessingException the json processing exception
+     */
     @GetMapping(value = "/product")
     public JsonNode getProducts() throws JsonProcessingException {
         GQL gqlInstance = GQL.Builder.newInstance()
@@ -36,6 +50,12 @@ public JsonNode getProducts() throws JsonProcessingException {
     }
 
 
+    /**
+     * Gets about.
+     *
+     * @return the about
+     * @throws JsonProcessingException the json processing exception
+     */
     @GetMapping(value = "/about")
     public JsonNode getAbout() throws JsonProcessingException {
         GQL gqlInstance = GQL.Builder.newInstance()
@@ -58,6 +78,12 @@ public JsonNode getAbout() throws JsonProcessingException {
     }
 
 
+    /**
+     * Gets banner.
+     *
+     * @return the banner
+     * @throws JsonProcessingException the json processing exception
+     */
     @GetMapping(value = "/banner")
     public JsonNode getBanner() throws JsonProcessingException {
         GQL gqlInstance = GQL.Builder.newInstance()
@@ -86,6 +112,12 @@ public JsonNode getBanner() throws JsonProcessingException {
     }
 
 
+    /**
+     * Gets contact.
+     *
+     * @return the contact
+     * @throws JsonProcessingException the json processing exception
+     */
     @GetMapping(value = "/contact")
     public JsonNode getContact() throws JsonProcessingException {
         GQL gqlInstance = GQL.Builder.newInstance()