Add missing Javadoc

Author: laurentpellegrino

src/main/java/co/ipregistry/api/client/IpregistryClient.java

@@ -206,6 +206,16 @@ public IpInfoList lookup(final List<String> ips, final IpregistryOption... optio
         return new IpInfoList(result);
     }
 
+    /**
+     * Parse the given {@code userAgents} values.
+     *
+     * @param userAgents the raw user-agent values.
+     *                   A typical raw user-agent value is the value you retrieve for the user-agent header
+     *                   from an incoming HTTP request.
+     * @return parsed data associated with incoming {@code userAgents}.
+     * @throws ApiException    if an API issue happens.
+     * @throws ClientException if a client issue happens.
+     */
     public UserAgentList parse(final String... userAgents) throws ApiException, ClientException {
         return requestHandler.parse(userAgents);
     }

src/main/java/co/ipregistry/api/client/model/UserAgentList.java

@@ -16,6 +16,7 @@
 
 package co.ipregistry.api.client.model;
 
+import co.ipregistry.api.client.exceptions.IpInfoException;
 import co.ipregistry.api.client.exceptions.UserAgentException;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -57,6 +58,16 @@ public void set(final int index, final Object value) {
         userAgents[index] = value;
     }
 
+    /**
+     * Returns data for the user-agent at the specified {@code index}.
+     * If an exception was thrown while handling the associated request, this exception is rethrown when invoking this method.
+     * <p>
+     * The order is the one of the requests that have been inputted for dispatching.
+     *
+     * @param index the index of the list.
+     * @return UserAgent data at the specified index.
+     * @throws UserAgentException if an exception was thrown while handling the associated request.
+     */
     public UserAgent get(final int index) throws UserAgentException {
         final Object object = userAgents[index];
 
@@ -80,6 +91,15 @@ public int size() {
         return userAgents.length;
     }
 
+    /**
+     * Returns data for the user-agent at the specified {@code index}.
+     * If an exception was thrown while handling the associated request, the return value is an exception. Otherwise, this is the IpInfo data.
+     * <p>
+     * The order is the one of the requests that have been inputted for dispatching.
+     *
+     * @param index the index of the list.
+     * @return UserAgent data at the specified index, or the exception thrown while dispatching the associated request.
+     */
     public Object unsafeGet(final int index) {
         return userAgents[index];
     }

src/main/java/co/ipregistry/api/client/request/IpregistryRequestHandler.java

@@ -16,8 +16,6 @@
 
 package co.ipregistry.api.client.request;
 
-import co.ipregistry.api.client.exceptions.ApiException;
-import co.ipregistry.api.client.exceptions.ClientException;
 import co.ipregistry.api.client.exceptions.IpregistryException;
 import co.ipregistry.api.client.model.IpInfo;
 import co.ipregistry.api.client.model.IpInfoList;
@@ -58,6 +56,17 @@ public interface IpregistryRequestHandler {
      */
     IpInfoList lookup(Iterable<String> ips, IpregistryOption... options) throws IpregistryException;
 
-    UserAgentList parse(String... userAgents) throws ApiException, ClientException;
+    /**
+     * Parse the given {@code userAgents} values.
+     *
+     * @param userAgents the raw user-agent values.
+     *                   A typical raw user-agent value is the value you retrieve for the user-agent header
+     *                   from an incoming HTTP request.
+     * @return parsed data associated with incoming {@code userAgents}.
+     * @throws IpregistryException if an error happens when looking up data.
+     *                             It can be an {@link co.ipregistry.api.client.exceptions.ApiException}
+     *                             or a {@link co.ipregistry.api.client.exceptions.ClientException}.
+     */
+    UserAgentList parse(String... userAgents) throws IpregistryException;
 
 }