From: tcofoegbu <tcnofoegbu@dundee.ac.uk>
Date: Thu, 20 Apr 2017 17:14:37 +0000 (+0100)
Subject: JAL-2484 minor house-keeping and code docs
X-Git-Tag: Release_2_10_2~3^2~45^2~13
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=0c607193b6ee71e371b1c2239981ed97d15d6dfe;p=jalview.git

JAL-2484 minor house-keeping and code docs
---

diff --git a/src/jalview/io/cache/AppCache.java b/src/jalview/io/cache/AppCache.java
index 8ed33e6..fc528ef 100644
--- a/src/jalview/io/cache/AppCache.java
+++ b/src/jalview/io/cache/AppCache.java
@@ -113,18 +113,36 @@ public class AppCache
     Cache.setProperty(cacheKey, delimitedCacheString);
   }
 
+  /**
+   * Method for deleted cached items for a given cache key
+   * 
+   * @param cacheKey
+   */
   public void deleteCacheItems(String cacheKey)
   {
     cacheItems.put(cacheKey, new LinkedHashSet<String>());
     persistCache(cacheKey);
   }
 
+  /**
+   * Method for obtaining the preset maximum cache limit for a given cache key
+   * 
+   * @param cacheKey
+   * @return
+   */
   public String getCacheLmit(String cacheKey)
   {
     String uniqueKey = cacheKey + DEFAULT_LIMIT_KEY;
     return Cache.getDefault(uniqueKey, DEFAULT_LIMIT);
   }
 
+  /**
+   * Method for updating the preset maximum cache limit for a given cache key
+   * 
+   * @param cacheKey
+   * @param newLimit
+   * @return
+   */
   public int updateCacheLimit(String cacheKey, String newLimit)
   {
     String uniqueKey = cacheKey + DEFAULT_LIMIT_KEY;