Addressing comments.

sccalabr · sccalabr · commit f9b1b920b590 · 2017-10-22T13:18:03.000-05:00
diff --git a/src/main/java/com/sendgrid/SendGridAPI.java b/src/main/java/com/sendgrid/SendGridAPI.java
@@ -13,17 +13,17 @@ public interface SendGridAPI {
   public void initializeSendGrid(String apiKey);
 
   /**
-   * Initializes SendGrid
+   * Returns the library version
    * 
    * @param apiKey is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys
-   * @return
+   * @return the library version.
    */
   public String getLibraryVersion();
 
   /**
    * Gets the version.
    *
-   * @return
+   * @return returns the version.
    */
   public String getVersion();
 
@@ -36,31 +36,31 @@ public interface SendGridAPI {
 
   /**
    * Gets the request headers.
-   * @return
+   * @return returns a map of request headers.
    */
   public Map<String, String> getRequestHeaders();
 
   /**
    * Adds a request headers.
    * 
-   * @param keythe key
-   * @param valuethe value
-   * @return
+   * @param key the key
+   * @param value the value
+   * @return returns a map of request headers.
    */
   public Map<String, String> addRequestHeader(String key, String value);
 
   /**
    * Removes a request headers.
    * 
    * @param key the key
-   * @return
+   * @return returns a map of request headers.
    */
   public Map<String, String> removeRequestHeader(String key);
 
   /**
    * Gets the host.
    * 
-   * @return
+   * @return returns the host.
    */
   public String getHost();
 
@@ -76,8 +76,8 @@ public interface SendGridAPI {
    * testing.
    * 
    * @param request
-   * @return
-   * @throws IOException
+   * @return returns a response.
+   * @throws IOException in case of network or marshal error.
    */
   public Response makeCall(Request request) throws IOException;
 
@@ -86,7 +86,7 @@ public interface SendGridAPI {
    * 
    * @param request
    * @return
-   * @throws IOException
+   * @throws IOException in case of network or marshal error.
    */
   public Response api(Request request) throws IOException;
 }
