Updates to Javadocs to allow mvn site to complete successfully
git-svn-id: https://svn.apache.org/repos/asf/turbine/fulcrum/trunk/cache@1889962 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/fulcrum/cache/GlobalCacheService.java b/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
index 0f1d32c..b556b86 100644
--- a/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
+++ b/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
@@ -37,10 +37,11 @@
/**
* Gets a cached object given its id (a String).
*
+ * @param <T> type of object to return
* @param id
* The String id for the object.
* @return A CachedObject.
- * @exception ObjectExpiredException,
+ * @throws ObjectExpiredException
* if the object has expired in the cache.
*/
<T> CachedObject<T> getObject(String id) throws ObjectExpiredException;
@@ -48,6 +49,7 @@
/**
* Adds an object to the cache.
*
+ * @param <T> type of object to add
* @param id
* The String id for the object.
* @param o
@@ -84,6 +86,7 @@
* Returns the current size of the cache.
*
* @return int representing current cache size in number of bytes
+ * @throws IOException if unable to return cache size
*/
int getCacheSize() throws IOException;
diff --git a/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java b/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
index 4cf47a8..b4d0b8c 100644
--- a/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
+++ b/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
@@ -113,6 +113,8 @@
/**
* Returns true if the object hasn't been touched in the previous TTL
* period.
+ *
+ * @return boolean status of object
*/
public synchronized boolean isUntouched()
{
diff --git a/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java b/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
index edc1ade..4cb9d22 100644
--- a/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
+++ b/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
@@ -117,7 +117,7 @@
* @param id
* The key of the stored object.
* @return The object from the cache.
- * @exception ObjectExpiredException,
+ * @throws ObjectExpiredException
* when either the object is not in the cache or it has
* expired.
*/
