Javadocs.

Agadar · Dec 26, 2017 · e22c05f · e22c05f
1 parent ac9bbbf
commit e22c05f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/src/main/java/com/github/agadar/nationstates/NationStates.java b/src/main/java/com/github/agadar/nationstates/NationStates.java
@@ -97,7 +97,7 @@ public final class NationStates implements INationStates {
      * include your e-mail address, a link to a website you own, or something
      * else that can help them contact you if needed.
      *
-     * @param userAgent
+     * @param userAgent the User Agent to use for API calls
      */
     public NationStates(String userAgent) {
         this.setUserAgent(userAgent);

diff --git a/src/main/java/com/github/agadar/nationstates/query/APIQuery.java b/src/main/java/com/github/agadar/nationstates/query/APIQuery.java
@@ -22,7 +22,7 @@ public abstract class APIQuery<Q extends APIQuery, R> extends AbstractQuery<Q, R
      * Rate limiter for API calls when scraping.
      */
     private final IRateLimiter scrapingRateLimiter;
-    
+
     /**
      * The version of the NationStates API to target.
      */
@@ -42,13 +42,14 @@ public abstract class APIQuery<Q extends APIQuery, R> extends AbstractQuery<Q, R
     /**
      * Constructor. Sets the resource value, e.g. the nation's or region's name.
      *
-     * @param xmlConverter
-     * @param resourceValue the resource value
-     * @param generalRateLimiter
-     * @param baseUrl
-     * @param userAgent
-     * @param apiVersion
-     * @param scrapingRateLimiter
+     * @param xmlConverter The converter for translating XML from the API to
+     * objects.
+     * @param resourceValue The resource value (e.g. 'nation', 'region'...)
+     * @param generalRateLimiter The default rate limiter
+     * @param baseUrl The URL to the API to consume
+     * @param userAgent The User Agent to communicate with
+     * @param apiVersion The version of the API to expect to consume
+     * @param scrapingRateLimiter Rate limiter used when 'scraping'
      */
     protected APIQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter,
             String baseUrl, String userAgent, int apiVersion, String resourceValue) {

diff --git a/src/main/java/com/github/agadar/nationstates/query/AbstractQuery.java b/src/main/java/com/github/agadar/nationstates/query/AbstractQuery.java
@@ -39,7 +39,8 @@ public abstract class AbstractQuery<Q extends AbstractQuery, R> {
     /**
      * Constructor, setting the returnType.
      *
-     * @param xmlConverter
+     * @param xmlConverter The converter for translating XML from the API to
+     * objects.
      * @param baseUrl Base URL to NationStates.
      * @param userAgent User agent by which this library or its consumer is
      * recognized.