From 80675ce1d2b6f87591f04e6c3b443083fd412b2e Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Tue, 6 Oct 2015 08:03:45 -0700 Subject: [PATCH] Javadoc fixes --- .../websocket/basicscope/ScopeBasicsTest.java | 1 + .../wsscope/WebSocketScopeBaselineTest.java | 1 + .../InfinispanSessionIdManager.java | 28 ++++++--------- .../infinispan/InfinispanSessionManager.java | 34 +++++++++---------- .../jetty/maven/plugin/AbstractJettyMojo.java | 2 +- 5 files changed, 31 insertions(+), 35 deletions(-) diff --git a/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/basicscope/ScopeBasicsTest.java b/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/basicscope/ScopeBasicsTest.java index 3561b2499bd..1b5892086fd 100644 --- a/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/basicscope/ScopeBasicsTest.java +++ b/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/basicscope/ScopeBasicsTest.java @@ -57,6 +57,7 @@ public class ScopeBasicsTest /** * Validation of Scope / Inject logic on non-websocket-scoped classes + * @throws Exception on test failure */ @Test public void testBasicBehavior() throws Exception diff --git a/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/wsscope/WebSocketScopeBaselineTest.java b/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/wsscope/WebSocketScopeBaselineTest.java index 3c9e2e135d4..ba1fd997e51 100644 --- a/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/wsscope/WebSocketScopeBaselineTest.java +++ b/jetty-cdi/cdi-websocket/src/test/java/org/eclipse/jetty/cdi/websocket/wsscope/WebSocketScopeBaselineTest.java @@ -61,6 +61,7 @@ public class WebSocketScopeBaselineTest * Test behavior of {@link WebSocketScope} in basic operation. *

* Food is declared as part of WebSocketScope, and as such, only 1 instance of it can exist. + * @throws Exception on test failure */ @Test public void testScopeBehavior() throws Exception diff --git a/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionIdManager.java b/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionIdManager.java index 7ca6a58b739..d7da9149f7d 100644 --- a/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionIdManager.java +++ b/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionIdManager.java @@ -77,19 +77,12 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager - /** - * @param server - */ public InfinispanSessionIdManager(Server server) { super(); _server = server; } - /** - * @param server - * @param random - */ public InfinispanSessionIdManager(Server server, Random random) { super(random); @@ -279,7 +272,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Get the cache. - * @return + * @return the cache */ public BasicCache getCache() { @@ -288,7 +281,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Set the cache. - * @param cache + * @param cache the cache */ public void setCache(BasicCache cache) { @@ -300,7 +293,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Do any operation to the session id in the cache to * ensure its idle expiry time moves forward - * @param id + * @param id the session id */ public void touch (String id) { @@ -312,8 +305,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Ask the cluster if a particular id exists. * - * @param id - * @return + * @param id the session id + * @return true if exists */ protected boolean exists (String id) { @@ -327,7 +320,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Put a session id into the cluster. * - * @param id + * @param id the session id */ protected void insert (String id) { @@ -341,7 +334,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Put a session id into the cluster with an idle expiry. * - * @param id + * @param id the session id + * @param idleTimeOutSec idle timeout in seconds */ protected void insert (String id, long idleTimeOutSec) { @@ -355,7 +349,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Remove a session id from the cluster. * - * @param id + * @param id the session id */ protected void delete (String id) { @@ -370,8 +364,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager /** * Generate a unique cache key from the session id. * - * @param id - * @return + * @param id the session id + * @return unique cache id */ protected String makeKey (String id) { diff --git a/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionManager.java b/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionManager.java index b2e898d05ad..039263a46cf 100644 --- a/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionManager.java +++ b/jetty-infinispan/src/main/java/org/eclipse/jetty/session/infinispan/InfinispanSessionManager.java @@ -267,7 +267,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * A new session. * - * @param request + * @param request the request */ protected Session (HttpServletRequest request) { @@ -295,10 +295,10 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * A restored session. * - * @param sessionId - * @param created - * @param accessed - * @param maxInterval + * @param sessionId the session id + * @param created time created + * @param accessed time last accessed + * @param maxInterval max expiry interval */ protected Session (String sessionId, long created, long accessed, long maxInterval) { @@ -406,8 +406,8 @@ public class InfinispanSessionManager extends AbstractSessionManager } /** Test if the session is stale - * @param atTime - * @return + * @param atTime time when stale + * @return true if stale */ protected boolean isStale (long atTime) { @@ -416,7 +416,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** Test if the session is dirty - * @return + * @return true if dirty */ protected boolean isDirty () { @@ -711,7 +711,7 @@ public class InfinispanSessionManager extends AbstractSessionManager * often. * * - * @param sec + * @param sec scavenge interval in seconds */ public void setScavengeInterval (long sec) { @@ -752,7 +752,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Get the clustered cache instance. * - * @return + * @return the cache */ public BasicCache getCache() { @@ -764,7 +764,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Set the clustered cache instance. * - * @param cache + * @param cache the cache */ public void setCache (BasicCache cache) { @@ -990,8 +990,8 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Load a session from the clustered cache. * - * @param key - * @return + * @param key the session key + * @return the session */ protected Session load (String key) { @@ -1019,8 +1019,8 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Save or update the session to the cluster cache * - * @param session - * @throws Exception + * @param session the session + * @throws Exception if unable to save */ protected void save (InfinispanSessionManager.Session session) throws Exception @@ -1053,7 +1053,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Remove the session from the cluster cache. * - * @param session + * @param session the session */ protected void delete (InfinispanSessionManager.Session session) { @@ -1067,7 +1067,7 @@ public class InfinispanSessionManager extends AbstractSessionManager /** * Invalidate a session for this context with the given id * - * @param idInCluster + * @param idInCluster session id in cluster */ public void invalidateSession (String idInCluster) { diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java index 22adeb0bacd..402ad482435 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java @@ -564,7 +564,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo * Run a scanner thread on the given list of files and directories, calling * stop/start on the given list of LifeCycle objects if any of the watched * files change. - * + * @throws Exception if unable to start scanner */ public void startScanner() throws Exception {