Merge pull request #27 from WURFL/develop

[1.0.15] More javadoc fixed part 2
WURFL · Jun 8, 2021 · 39acc28 · 39acc28
2 parents b9fa830 + 677cbcf
commit 39acc28
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java
@@ -69,7 +69,7 @@ public class CloudClient extends Loggable implements ICloudClientRequest, Consta
     private static final int HTTP_ERROR_JSON_KEY = 500;
 
     /**
-     * The HTTP Headers that will be used to query the WURFL Cloud Server in Map<String, String> format.
+     * The HTTP Headers that will be used to query the WURFL Cloud Server in Map format.
      */
     private final Map<String, String> reqHeaders = new LinkedHashMap<String, String>();
 

diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientManager.java b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientManager.java
@@ -100,22 +100,22 @@ public class CloudClientManager extends Loggable implements CloudListener, IClou
 
     /**
      * CloudClientManager constructor.
-     * @param authenticationManager
-     * @param config
-     * @param cache
-     * @param proxy
+     * @param authenticationManager the auth manager
+     * @param config cloud config object
+     * @param cache cache implementation
+     * @param proxy proxy used for connection
      */
     public CloudClientManager(IAuthenticationManager authenticationManager, CloudClientConfig config, IWurflCloudCache cache, Proxy proxy) {
         this(authenticationManager, config, cache, proxy, null);
     }
 
     /**
      * Full constructor.
-     * @param authenticationManager
-     * @param config
-     * @param cache
-     * @param proxy
-     * @param parsedCapabilities
+     * @param authenticationManager the auth manager
+     * @param config cloud config object
+     * @param cache cache implementation
+     * @param proxy proxy used for connection
+     * @param parsedCapabilities array of capabilities to be used
      */
     public CloudClientManager(IAuthenticationManager authenticationManager, CloudClientConfig config, IWurflCloudCache cache, Proxy proxy, String[] parsedCapabilities) {
         this.config = config;

diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/cache/IWurflCloudCache.java b/code/src/main/java/com/scientiamobile/wurflcloud/cache/IWurflCloudCache.java
@@ -26,6 +26,9 @@ public interface IWurflCloudCache extends Constants {
 
     /**
      * Get the device capabilities for the given user agent from the cache provider
+     * @param request HTTP request object
+     * @param client wurfl cloud client request object
+     * @return a detected AbstractDevice implementation
      */
     public AbstractDevice getDevice(HttpServletRequest request, ICloudClientRequest client);
     /**
@@ -64,7 +67,6 @@ public interface IWurflCloudCache extends Constants {
 
     /**
      * Sets the last loaded WURFL timestamp in the cache provider
-     * @link IWurflCloudCache.#getMtime()
      *
      * @param server_mtime The new time to set
      * @return True if the new time was set successfully, false otherwise

diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/cache/SimpleCookieCache.java b/code/src/main/java/com/scientiamobile/wurflcloud/cache/SimpleCookieCache.java
@@ -90,9 +90,9 @@ public AbstractDevice getDeviceFromID(String key) {
     /**
      * Sets a cookie in the response, with max age default cache expiration.
      *
-     * @param response
-     * @param key
-     * @param device
+     * @param response the HTTP servlet response object
+     * @param key cookie key
+     * @param device the device object to use to set the cookie
      * @return true if device has been set properly, false if any error occurred
      */
     public boolean setDevice(HttpServletResponse response, String key, AbstractDevice device) {