From 6bc437c298ca1cd52bb04f4356267f4a146a8710 Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Thu, 29 Apr 2010 23:03:04 +0000 Subject: [PATCH] 309185 - Fix the over 300 Javadoc warnings git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1626 7e9141cc-0065-0410-87d8-b60c137991c4 --- .../eclipse/jetty/embedded/FileServerXml.java | 3 ++- .../eclipse/jetty/embedded/ManyHandlers.java | 2 +- .../jetty/annotations/AnnotationParser.java | 1 - .../jetty/annotations/ClassNameResolver.java | 4 ++-- .../ResourceAnnotationHandler.java | 1 - .../org/eclipse/jetty/annotations/Util.java | 14 ++++++++++---- .../org/eclipse/jetty/client/HttpClient.java | 13 +++---------- .../eclipse/jetty/client/HttpExchange.java | 6 +++--- .../jetty/continuation/Continuation.java | 12 ++++++------ .../org/eclipse/jetty/http/HttpParser.java | 17 +++-------------- .../org/eclipse/jetty/http/HttpStatus.java | 10 +++++----- .../eclipse/jetty/io/nio/SelectorManager.java | 2 -- .../eclipse/jetty/jndi/ContextFactory.java | 2 +- .../org/eclipse/jetty/jndi/NamingUtil.java | 4 ++-- .../jndi/factories/MailSessionReference.java | 2 +- .../jetty/plus/annotation/Injection.java | 5 ++--- .../plus/annotation/LifeCycleCallback.java | 2 +- .../plus/jaas/spi/AbstractLoginModule.java | 6 +++--- .../plus/jaas/spi/DataSourceLoginModule.java | 7 +++---- .../jetty/plus/jaas/spi/JDBCLoginModule.java | 12 ++---------- .../jetty/plus/jaas/spi/LdapLoginModule.java | 12 ++++++------ .../jaas/spi/PropertyFileLoginModule.java | 1 - .../eclipse/jetty/plus/jndi/NamingEntry.java | 6 +++--- .../jetty/plus/jndi/NamingEntryUtil.java | 8 ++++---- .../eclipse/jetty/plus/jndi/Transaction.java | 9 +-------- .../jetty/plus/servlet/ServletHandler.java | 4 ++-- .../plus/webapp/AbstractConfiguration.java | 1 - .../jetty/plus/webapp/Configuration.java | 6 +++--- .../jetty/plus/webapp/EnvConfiguration.java | 4 ++-- .../jetty/plus/jndi/TestNamingEntries.java | 6 +++--- .../rewrite/handler/HeaderPatternRule.java | 2 +- .../jetty/rewrite/handler/RewriteHandler.java | 4 ++-- .../handler/VirtualHostRuleContainer.java | 2 +- .../jetty/server/AbstractConnector.java | 8 ++++---- .../org/eclipse/jetty/server/HttpOutput.java | 2 +- .../org/eclipse/jetty/server/Request.java | 6 +++--- .../org/eclipse/jetty/server/Response.java | 6 +----- .../jetty/server/handler/ContextHandler.java | 2 +- .../handler/ContextHandlerCollection.java | 2 -- .../jetty/server/handler/HandlerList.java | 2 +- .../jetty/server/handler/ProxyHandler.java | 2 +- .../server/nio/SelectChannelConnector.java | 2 +- .../session/AbstractSessionManager.java | 12 +++++------- .../server/session/HashSessionIdManager.java | 19 ++++++++++--------- .../server/session/JDBCSessionIdManager.java | 2 +- .../server/session/JDBCSessionManager.java | 2 +- .../server/ssl/SslSelectChannelConnector.java | 1 - .../jetty/server/ssl/SslSocketConnector.java | 9 +++++---- .../server/CheckReverseProxyHeadersTest.java | 2 +- .../java/org/eclipse/jetty/util/Scanner.java | 2 +- .../org/eclipse/jetty/util/UrlEncoded.java | 8 ++++++-- .../org/eclipse/jetty/util/log/Logger.java | 3 --- .../jetty/util/resource/JarFileResource.java | 6 +++--- .../jetty/util/statistic/SampleStatistic.java | 4 ++-- 54 files changed, 126 insertions(+), 166 deletions(-) diff --git a/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/FileServerXml.java b/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/FileServerXml.java index d9bf0a34468..6cf59bad31c 100644 --- a/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/FileServerXml.java +++ b/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/FileServerXml.java @@ -10,7 +10,8 @@ import org.eclipse.jetty.xml.XmlConfiguration; * This server is identical to {@link FileServer}, except that it * is configured via an {@link XmlConfiguration} config file that * does the identical work. - * @see http://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk/example-jetty-embedded/src/main/resources/fileserver.xml + *

+ * See fileserver.xml */ public class FileServerXml { diff --git a/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/ManyHandlers.java b/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/ManyHandlers.java index 45e512f8b62..59608de10c9 100644 --- a/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/ManyHandlers.java +++ b/example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/ManyHandlers.java @@ -50,7 +50,7 @@ import org.eclipse.jetty.util.ajax.JSON; *

  • {@link HandlerWrapper} which will nest one handler inside another. In * this example, the HelloHandler is nested inside a HandlerWrapper that sets * the greeting as a request attribute. - *
  • {@link ListHandler} which will call a collection of handlers until the + *
  • {@link HandlerList} which will call a collection of handlers until the * request is marked as handled. In this example, a list is used to combine the * param handler (which only handles the request if there are parameters) and * the wrapper handler. Frequently handler lists are terminated with the diff --git a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java index 7cd647a4dbb..5c1338c66f8 100644 --- a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java +++ b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java @@ -499,7 +499,6 @@ public class AnnotationParser * Only class files in jar files will be scanned. * @param loader * @param visitParents - * @param jarNamePattern * @param nullInclusive * @param resolver * @throws Exception diff --git a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ClassNameResolver.java b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ClassNameResolver.java index a76544306dd..9aa6f3ea079 100644 --- a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ClassNameResolver.java +++ b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ClassNameResolver.java @@ -21,7 +21,7 @@ public interface ClassNameResolver * Based on the execution context, should the class represented * by "name" be excluded from consideration? * @param name - * @return + * @return true if classname is excluded */ public boolean isExcluded (String name); @@ -31,7 +31,7 @@ public interface ClassNameResolver * represented by "name" is detected, should the existing * one be overridden or not? * @param name - * @return + * @return true if name should be overridden */ public boolean shouldOverride (String name); } diff --git a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ResourceAnnotationHandler.java b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ResourceAnnotationHandler.java index 8e80112662c..b506dac71fa 100644 --- a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ResourceAnnotationHandler.java +++ b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ResourceAnnotationHandler.java @@ -187,7 +187,6 @@ public class ResourceAnnotationHandler implements AnnotationHandler * * This will generate a JNDI entry, and an Injection to be * processed when an instance of the class is created. - * @param injections */ public void handleMethod(String className, String methodName, int access, String desc, String signature, String[] exceptions, String annotation, List values) diff --git a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/Util.java b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/Util.java index 34ebe8d52e4..d1ad40bbf4d 100644 --- a/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/Util.java +++ b/jetty-annotations/src/main/java/org/eclipse/jetty/annotations/Util.java @@ -21,8 +21,6 @@ import org.objectweb.asm.Type; /** * Util - * - * */ public class Util { @@ -37,8 +35,16 @@ public class Util /** * Check if the presented method belongs to a class that is one * of the classes with which a servlet container should be concerned. - * @param m - * @return + * @param c + * @return true if class is a type of one of the following: + * ({@link javax.servlet.Servlet}, + * {@link javax.servlet.Filter}, + * {@link javax.servlet.ServletContextListener}, + * {@link javax.servlet.ServletContextAttributeListener}, + * {@link javax.servlet.ServletRequestListener}, + * {@link javax.servlet.ServletRequestAttributeListener}, + * {@link javax.servlet.http.HttpSessionListener}, + * {@link javax.servlet.http.HttpSessionAttributeListener}) */ public static boolean isServletType (Class c) { diff --git a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java index 0ee716cf163..1a5edc296b8 100644 --- a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java +++ b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java @@ -75,11 +75,8 @@ import org.eclipse.jetty.util.thread.Timeout; * be allocated from a destination, so that multiple request sources are not multiplexed * over the same connection. * - * - * - * - * @see {@link HttpExchange} - * @see {@link HttpDestination} + * @see HttpExchange + * @see HttpDestination */ public class HttpClient extends HttpBuffers implements Attributes { @@ -212,10 +209,6 @@ public class HttpClient extends HttpBuffers implements Attributes } /* ------------------------------------------------------------ */ - /** - * @param name - * @return - */ public void clearAttributes() { _attributes.clearAttributes(); @@ -287,7 +280,7 @@ public class HttpClient extends HttpBuffers implements Attributes /** * returns the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null * - * @return + * @return the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null */ public RealmResolver getRealmResolver() { diff --git a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpExchange.java b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpExchange.java index 20b880fa2de..2a1039d7d52 100644 --- a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpExchange.java +++ b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpExchange.java @@ -54,8 +54,8 @@ import org.eclipse.jetty.util.log.Log; * see {@link org.eclipse.jetty.client.ContentExchange} and {@link org.eclipse.jetty.client.CachedExchange}.

    * *

    Typically the HttpExchange is passed to the {@link HttpClient#send(HttpExchange)} method, which in - * turn selects a {@link HttpDestination} and calls its {@link HttpDestination#send(HttpExchange), which - * then creates or selects a {@link HttpConnection} and calls its {@link HttpConnection#send(HttpExchange). + * turn selects a {@link HttpDestination} and calls its {@link HttpDestination#send(HttpExchange)}, which + * then creates or selects a {@link HttpConnection} and calls its {@link HttpConnection#send(HttpExchange)}. * A developer may wish to directly call send on the destination or connection if they wish to bypass * some handling provided (eg Cookie handling in the HttpDestination).

    * @@ -130,7 +130,7 @@ public class HttpExchange * || onExpire * || onRequestComplete && onResponseComplete * - * @return + * @return the done status * @throws InterruptedException */ public int waitForDone () throws InterruptedException diff --git a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java index 4811b8f11ce..c60e6e110e3 100644 --- a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java +++ b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java @@ -27,10 +27,10 @@ import javax.servlet.ServletResponseWrapper; * A continuation is a mechanism by which a HTTP Request can be suspended and * restarted after a timeout or an asynchronous event has occurred. *

    - * The continuation mechanism is a portable mechansim that will work - * asychronously without additional configuration of all jetty-7, + * The continuation mechanism is a portable mechanism that will work + * asynchronously without additional configuration of all jetty-7, * jetty-8 and Servlet 3.0 containers. With the addition of - * the {@link ContinuationFilter}, the mechansism will also work + * the {@link ContinuationFilter}, the mechanism will also work * asynchronously on jetty-6 and non-asynchronously on any * servlet 2.5 container. *

    @@ -121,7 +121,7 @@ import javax.servlet.ServletResponseWrapper; *

    Continuation Timeout

    *

    * If a continuation is suspended, but neither {@link #complete()} or {@link #resume()} is - * called during the period set by {@link #setTimeout()}, then the continuation will + * called during the period set by {@link #setTimeout(long)}, then the continuation will * expire and {@link #isExpired()} will return true. *

    *

    @@ -245,7 +245,7 @@ public interface Continuation * within the filter chain and/or servlet service method), then the resume * does not take effect until the call to the filter chain and/or servlet * returns to the container. In this case both {@link #isSuspended()} and - * {@link isResumed()} return true. Multiple calls to resume are ignored. + * {@link #isResumed()} return true. Multiple calls to resume are ignored. *

    *

    * Typically resume() is used after a call to {@link #suspend()} with @@ -276,7 +276,7 @@ public interface Continuation * within the filter chain and/or servlet service method), then the complete * does not take effect until the call to the filter chain and/or servlet * returns to the container. In this case both {@link #isSuspended()} and - * {@link isResumed()} return true. + * {@link #isResumed()} return true. *

    * *

    diff --git a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java index 3d660700f5f..006e3fc1faf 100644 --- a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java +++ b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java @@ -26,18 +26,6 @@ import org.eclipse.jetty.io.BufferCache.CachedBuffer; import org.eclipse.jetty.util.StringUtil; import org.eclipse.jetty.util.log.Log; -/* ------------------------------------------------------------------------------- */ -/** - * - */ - -/* ------------------------------------------------------------ */ -/** - */ - -/* ------------------------------------------------------------ */ -/** - */ public class HttpParser implements Parser { // States @@ -110,8 +98,9 @@ public class HttpParser implements Parser /* ------------------------------------------------------------------------------- */ /** * Constructor. - * @param headerBufferSize size in bytes of header buffer - * @param contentBufferSize size in bytes of content buffer + * @param buffers the buffers to use + * @param endp the endpoint + * @param handler the even handler */ public HttpParser(Buffers buffers, EndPoint endp, EventHandler handler) { diff --git a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpStatus.java b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpStatus.java index 6e7fd2d90df..af9f1a2eb36 100644 --- a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpStatus.java +++ b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpStatus.java @@ -256,7 +256,7 @@ import org.eclipse.jetty.util.TypeUtil; * * * - * {@link #BAD_REQUEST} + * {@link #BAD_REQUEST_400} * 400 * Bad Request * @@ -266,7 +266,7 @@ import org.eclipse.jetty.util.TypeUtil; *   * * - * {@link #UNAUTHORIZED} + * {@link #UNAUTHORIZED_401} * 401 * Unauthorized * @@ -276,7 +276,7 @@ import org.eclipse.jetty.util.TypeUtil; *   * * - * {@link #PAYMENT_REQUIRED} + * {@link #PAYMENT_REQUIRED_402} * 402 * Payment Required * @@ -286,7 +286,7 @@ import org.eclipse.jetty.util.TypeUtil; *   * * - * {@link #FORBIDDEN} + * {@link #FORBIDDEN_403} * 403 * Forbidden * @@ -504,7 +504,7 @@ import org.eclipse.jetty.util.TypeUtil; * Sec. 10.3 * * - * {@link #LOCKED} + * {@link #LOCKED_423} * 423 * Locked *   diff --git a/jetty-io/src/main/java/org/eclipse/jetty/io/nio/SelectorManager.java b/jetty-io/src/main/java/org/eclipse/jetty/io/nio/SelectorManager.java index 27dabf08467..abd91be1752 100644 --- a/jetty-io/src/main/java/org/eclipse/jetty/io/nio/SelectorManager.java +++ b/jetty-io/src/main/java/org/eclipse/jetty/io/nio/SelectorManager.java @@ -99,7 +99,6 @@ public abstract class SelectorManager extends AbstractLifeCycle /** Register a channel * @param channel * @param att Attached Object - * @throws IOException */ public void register(SocketChannel channel, Object att) { @@ -121,7 +120,6 @@ public abstract class SelectorManager extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** Register a {@link ServerSocketChannel} * @param acceptChannel - * @throws IOException */ public void register(ServerSocketChannel acceptChannel) { diff --git a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/ContextFactory.java b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/ContextFactory.java index ca00153e1b0..75e626a72c1 100644 --- a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/ContextFactory.java +++ b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/ContextFactory.java @@ -151,7 +151,7 @@ public class ContextFactory implements ObjectFactory * Keep trying ancestors of the given classloader to find one to which * the context is bound. * @param loader - * @return + * @return the context from the parent class loader */ public Context getParentClassLoaderContext (ClassLoader loader) { diff --git a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/NamingUtil.java b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/NamingUtil.java index df635a6eabc..0f2cf7bb185 100644 --- a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/NamingUtil.java +++ b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/NamingUtil.java @@ -41,11 +41,11 @@ public class NamingUtil /* ------------------------------------------------------------ */ /** - * Bind an object to a context ensuring all subcontexts + * Bind an object to a context ensuring all sub-contexts * are created if necessary * * @param ctx the context into which to bind - * @param name the name relative to context to bind + * @param nameStr the name relative to context to bind * @param obj the object to be bound * @exception NamingException if an error occurs */ diff --git a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/factories/MailSessionReference.java b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/factories/MailSessionReference.java index 80e95d677b5..e6ff384f548 100644 --- a/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/factories/MailSessionReference.java +++ b/jetty-jndi/src/main/java/org/eclipse/jetty/jndi/factories/MailSessionReference.java @@ -111,7 +111,7 @@ public class MailSessionReference extends Reference implements ObjectFactory * @param arg1 not used * @param arg2 not used * @param arg3 not used - * @return + * @return the object found * @throws Exception */ public Object getObjectInstance(Object ref, Name arg1, Context arg2, Hashtable arg3) throws Exception diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/Injection.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/Injection.java index 2c03312645c..4b9c83ac1b7 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/Injection.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/Injection.java @@ -183,7 +183,6 @@ public class Injection /** * Inject a value for a Resource from JNDI into an object * @param injectable - * @throws Exception */ public void inject (Object injectable) { @@ -214,8 +213,8 @@ public class Injection /** * The Resource must already exist in the ENC of this webapp. - * @return - * @throws Exception + * @return the injected valud + * @throws NamingException */ public Object lookupInjectedValue () throws NamingException diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/LifeCycleCallback.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/LifeCycleCallback.java index 0554901f46a..d0df01730b2 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/LifeCycleCallback.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/LifeCycleCallback.java @@ -122,7 +122,7 @@ public abstract class LifeCycleCallback * @param clazz the class under inspection * @param methodName the method to find * @param checkInheritance false on first entry, true if a superclass is being introspected - * @return + * @return the method */ public Method findMethod (Package pack, Class clazz, String methodName, boolean checkInheritance) { diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/AbstractLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/AbstractLoginModule.java index b531f7cc02b..dc6cd9975ec 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/AbstractLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/AbstractLoginModule.java @@ -165,7 +165,7 @@ public abstract class AbstractLoginModule implements LoginModule /** * @see javax.security.auth.spi.LoginModule#commit() - * @return + * @return true if committed, false if not (likely not authenticated) * @throws LoginException */ public boolean commit() throws LoginException @@ -201,7 +201,7 @@ public abstract class AbstractLoginModule implements LoginModule /** * @see javax.security.auth.spi.LoginModule#login() - * @return + * @return true if is authenticated, false otherwise * @throws LoginException */ public boolean login() throws LoginException @@ -252,7 +252,7 @@ public abstract class AbstractLoginModule implements LoginModule /** * @see javax.security.auth.spi.LoginModule#logout() - * @return + * @return true always * @throws LoginException */ public boolean logout() throws LoginException diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/DataSourceLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/DataSourceLoginModule.java index 668c01916fc..95926c30a25 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/DataSourceLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/DataSourceLoginModule.java @@ -27,8 +27,7 @@ import javax.sql.DataSource; * A LoginModule that uses a DataSource to retrieve user authentication * and authorisation information. * - * @see org.eclipse.jetty.server.server.plus.jaas.spi.JDBCLoginModule - * + * @see JDBCLoginModule */ public class DataSourceLoginModule extends AbstractDatabaseLoginModule { @@ -68,8 +67,8 @@ public class DataSourceLoginModule extends AbstractDatabaseLoginModule /** * Get a connection from the DataSource - * @see org.eclipse.jetty.server.server.plus.jaas.spi.AbstractDatabaseLoginModule#getConnection() - * @return + * @see AbstractDatabaseLoginModule#getConnection() + * @return the connection for the datasource * @throws Exception */ public Connection getConnection () diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/JDBCLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/JDBCLoginModule.java index 52421486548..31a799861de 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/JDBCLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/JDBCLoginModule.java @@ -36,13 +36,9 @@ import org.eclipse.jetty.util.log.Log; * *

    Usage

    * 
    - */
-/*
  *
    * - * @see * @version 1.0 Tue Apr 15 2003 - * */ public class JDBCLoginModule extends AbstractDatabaseLoginModule { @@ -52,14 +48,10 @@ public class JDBCLoginModule extends AbstractDatabaseLoginModule private String dbPassword; - - - - /** * Get a connection from the DriverManager - * @see org.eclipse.jetty.server.server.plus.jaas.spi.AbstractDatabaseLoginModule#getConnection() - * @return + * @see AbstractDatabaseLoginModule#getConnection() + * @return the connection for this datasource * @throws Exception */ public Connection getConnection () diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java index ca009978e97..918f08295eb 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java @@ -182,7 +182,7 @@ public class LdapLoginModule extends AbstractLoginModule * roles are also an optional concept if required * * @param username - * @return + * @return the userinfo for the username * @throws Exception */ public UserInfo getUserInfo(String username) throws Exception @@ -367,7 +367,7 @@ public class LdapLoginModule extends AbstractLoginModule * then we try a binding authentication check, otherwise if we have the users encoded password then * we can try authentication via that mechanic * - * @return + * @return true if authenticated, false otherwise * @throws LoginException */ public boolean login() throws LoginException @@ -451,13 +451,13 @@ public class LdapLoginModule extends AbstractLoginModule /** * binding authentication check - * This methode of authentication works only if the user branch of the DIT (ldap tree) - * has an ACI (acces control instruction) that allow the access to any user or at least + * This method of authentication works only if the user branch of the DIT (ldap tree) + * has an ACI (access control instruction) that allow the access to any user or at least * for the user that logs in. * * @param username * @param password - * @return + * @return true always * @throws LoginException */ public boolean bindingLogin(String username, Object password) throws LoginException, NamingException @@ -610,7 +610,7 @@ public class LdapLoginModule extends AbstractLoginModule /** * get the context for connection * - * @return + * @return the environment details for the context */ public Hashtable getEnvironment() { diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/PropertyFileLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/PropertyFileLoginModule.java index c2f4ee935d0..d99db19a4e7 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/PropertyFileLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/PropertyFileLoginModule.java @@ -141,7 +141,6 @@ public class PropertyFileLoginModule extends AbstractLoginModule /** * Don't implement this as we want to pre-fetch all of the * users. - * @see org.eclipse.jetty.plus.jaas.spi.AbstractLoginModule#lazyLoadUser(java.lang.String) * @param username * @throws Exception */ diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java index 2fd2bcd8848..9c2d7f9952b 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java @@ -134,7 +134,7 @@ public abstract class NamingEntry /** * Get the unique name of the object * relative to the scope - * @return + * @return the unique jndi name of the object */ public String getJndiName () { @@ -143,7 +143,7 @@ public abstract class NamingEntry /** * Get the object that is to be bound - * @return + * @return the object that is to be bound */ public Object getObjectToBind() throws NamingException @@ -155,7 +155,7 @@ public abstract class NamingEntry /** * Get the name of the object, fully * qualified with the scope - * @return + * @return the name of the object, fully qualified with the scope */ public String getJndiNameInScope () { diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntryUtil.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntryUtil.java index 444fa68d42c..fa4f8416e23 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntryUtil.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntryUtil.java @@ -40,10 +40,10 @@ public class NamingEntryUtil * resource. The pre-existing resource can be either in the webapp's * naming environment, or in the container's naming environment. Webapp's * environment takes precedence over the server's namespace. - * + * + * @param scope the scope of the lookup * @param asName the name to bind as * @param mappedName the name from the environment to link to asName - * @param namingEntryType * @throws NamingException */ public static boolean bindToENC (Object scope, String asName, String mappedName) @@ -72,7 +72,7 @@ public class NamingEntryUtil * * @param scope * @param jndiName - * @return + * @return the naming entry for the given scope * @throws NamingException */ public static NamingEntry lookupNamingEntry (Object scope, String jndiName) @@ -115,7 +115,7 @@ public class NamingEntryUtil * * @param scope * @param clazz the type of the entry - * @return + * @return all NameEntries of a certain type in the given naming environment scope (server-wide names or context-specific names) * @throws NamingException */ public static List lookupNamingEntries (Object scope, Class clazz) diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/Transaction.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/Transaction.java index 39cefe456e8..397cad0fced 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/Transaction.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/Transaction.java @@ -27,13 +27,6 @@ import org.eclipse.jetty.util.log.Log; * Transaction * * Class to represent a JTA UserTransaction impl. - * - * - */ -/** - * Transaction - * - * */ public class Transaction extends NamingEntry { @@ -68,7 +61,7 @@ public class Transaction extends NamingEntry * Allow other bindings of UserTransaction. * * These should be in ADDITION to java:comp/UserTransaction - * @see org.eclipse.jetty.server.server.plus.jndi.NamingEntry#bindToENC(java.lang.String) + * @see NamingEntry#bindToENC(java.lang.String) */ public void bindToENC (String localName) throws NamingException diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/servlet/ServletHandler.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/servlet/ServletHandler.java index 4d54191565b..3c419001f2b 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/servlet/ServletHandler.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/servlet/ServletHandler.java @@ -100,7 +100,7 @@ public class ServletHandler extends org.eclipse.jetty.servlet.ServletHandler /** - * @see org.eclipse.jetty.servlet.servlet.ServletHandler#cusomizeFilterDestroy(javax.servlet.Filter) + * @see org.eclipse.jetty.servlet.ServletHandler#customizeFilterDestroy(Filter) */ public Filter customizeFilterDestroy(Filter filter) throws Exception { @@ -112,7 +112,7 @@ public class ServletHandler extends org.eclipse.jetty.servlet.ServletHandler /** - * @see org.eclipse.jetty.servlet.servlet.ServletHandler#customizeServletDestroy(javax.servlet.Servlet) + * @see org.eclipse.jetty.servlet.ServletHandler#customizeServletDestroy(Servlet) */ public Servlet customizeServletDestroy(Servlet servlet) throws Exception { diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/AbstractConfiguration.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/AbstractConfiguration.java index 39d424273b8..ac6ae7a9ba7 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/AbstractConfiguration.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/AbstractConfiguration.java @@ -345,7 +345,6 @@ public abstract class AbstractConfiguration implements Configuration * @param node * @param jndiName * @param valueClass - * @return the type of the injectable */ protected void initInjection (XmlParser.Node node, String jndiName, Class valueClass) { diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/Configuration.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/Configuration.java index ce77f51b282..bb4ffad3f64 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/Configuration.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/Configuration.java @@ -41,7 +41,7 @@ public class Configuration extends AbstractConfiguration /** - * @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindEnvEntry(java.lang.String, java.lang.String) + * @see AbstractConfiguration#bindEnvEntry(WebAppContext, String, Object) * @param name * @param value * @throws Exception @@ -82,7 +82,7 @@ public class Configuration extends AbstractConfiguration * If a resource reference with the same name is in a jetty-env.xml * file, it will already have been bound. * - * @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindResourceRef(java.lang.String) + * @see AbstractConfiguration#bindResourceRef(WebAppContext, String, Class) * @param name * @throws Exception */ @@ -93,7 +93,7 @@ public class Configuration extends AbstractConfiguration } /** - * @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindResourceEnvRef(java.lang.String) + * @see AbstractConfiguration#bindResourceEnvRef(WebAppContext, String, Class) * @param name * @throws Exception */ diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/EnvConfiguration.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/EnvConfiguration.java index d226a38429e..6500b1eab17 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/EnvConfiguration.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/EnvConfiguration.java @@ -53,7 +53,7 @@ public class EnvConfiguration implements Configuration /** - * @see org.eclipse.jetty.webapp.Configuration#configureDefaults() + * @see Configuration#configure(WebAppContext) * @throws Exception */ public void preConfigure (WebAppContext context) throws Exception @@ -108,7 +108,7 @@ public class EnvConfiguration implements Configuration /** * Remove all jndi setup - * @see org.eclipse.jetty.webapp.Configuration#deconfigureWebApp() + * @see Configuration#deconfigure(WebAppContext) * @throws Exception */ public void deconfigure (WebAppContext context) throws Exception diff --git a/jetty-plus/src/test/java/org/eclipse/jetty/plus/jndi/TestNamingEntries.java b/jetty-plus/src/test/java/org/eclipse/jetty/plus/jndi/TestNamingEntries.java index a83f1dd71fd..b2a85af4408 100644 --- a/jetty-plus/src/test/java/org/eclipse/jetty/plus/jndi/TestNamingEntries.java +++ b/jetty-plus/src/test/java/org/eclipse/jetty/plus/jndi/TestNamingEntries.java @@ -74,7 +74,7 @@ public class TestNamingEntries extends TestCase * @param arg1 * @param arg2 * @param arg3 - * @return + * @return the object instance * @throws Exception */ public Object getObjectInstance(Object arg0, Name arg1, Context arg2, Hashtable arg3) throws Exception @@ -106,7 +106,7 @@ public class TestNamingEntries extends TestCase /** * @see javax.naming.Referenceable#getReference() - * @return + * @return the reference * @throws NamingException */ public Reference getReference() throws NamingException @@ -130,7 +130,7 @@ public class TestNamingEntries extends TestCase * @param arg1 * @param arg2 * @param arg3 - * @return + * @return the object instance * @throws Exception */ public Object getObjectInstance(Object arg0, Name arg1, Context arg2, Hashtable arg3) throws Exception diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java index b0fbbcaf76a..cd2bfb40429 100644 --- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java +++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java @@ -72,7 +72,7 @@ public class HeaderPatternRule extends PatternRule * the new value overwrites the previous one. Otherwise, it adds the new * header name and value. * - *@see org.eclipse.jetty.server.server.rewrite.handler.Rule#matchAndApply(String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + *@see org.eclipse.jetty.rewrite.handler.Rule#matchAndApply(String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) */ public String apply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException { diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java index 57d1572a5dd..1178cb04de2 100644 --- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java +++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java @@ -26,7 +26,7 @@ import org.eclipse.jetty.server.handler.HandlerWrapper; /* ------------------------------------------------------------ */ /** *

    Rewrite handler is responsible for managing the rules. Its capabilities - * is not only limited for url rewrites such as RewritePatternRule or RewriteRegexRule. + * is not only limited for URL rewrites such as RewritePatternRule or RewriteRegexRule. * There is also handling for cookies, headers, redirection, setting status or error codes * whenever the rule finds a match. * @@ -283,7 +283,7 @@ public class RewriteHandler extends HandlerWrapper /* ------------------------------------------------------------ */ /** - * @param originalPathAttribte If non null, this string will be used + * @param originalPathAttribute If non null, this string will be used * as the attribute name to store the original request path. */ public void setOriginalPathAttribute(String originalPathAttribute) diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/VirtualHostRuleContainer.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/VirtualHostRuleContainer.java index eabb07837e6..8b3c023be3c 100644 --- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/VirtualHostRuleContainer.java +++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/VirtualHostRuleContainer.java @@ -52,7 +52,7 @@ public class VirtualHostRuleContainer extends RuleContainer /* ------------------------------------------------------------ */ /** Get the virtual hosts that the rules within this container will apply to - * @param virtualHosts Array of virtual hosts that the rules within this container are applied to. + * @return Array of virtual hosts that the rules within this container are applied to. * A null hostname or null/empty array means any hostname is acceptable. */ public String[] getVirtualHosts() diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java index 76064c46565..44ab1479103 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java @@ -777,7 +777,7 @@ public abstract class AbstractConnector extends HttpBuffers implements Connector /* ------------------------------------------------------------ */ /** - * @param forwardedHostHeader + * @param forwardedServerHeader * The header name for forwarded server (default * x-forwarded-server) */ @@ -794,12 +794,12 @@ public abstract class AbstractConnector extends HttpBuffers implements Connector /* ------------------------------------------------------------ */ /** - * @param forwardedHostHeader + * @param forwardedRemoteAddressHeader * The header name for forwarded for (default x-forwarded-for) */ - public void setForwardedForHeader(String forwardedRemoteAddressHeade) + public void setForwardedForHeader(String forwardedRemoteAddressHeader) { - _forwardedForHeader = forwardedRemoteAddressHeade; + _forwardedForHeader = forwardedRemoteAddressHeader; } /* ------------------------------------------------------------ */ diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/HttpOutput.java b/jetty-server/src/main/java/org/eclipse/jetty/server/HttpOutput.java index 403c29d803e..e7190a7b193 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/HttpOutput.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/HttpOutput.java @@ -28,7 +28,7 @@ import org.eclipse.jetty.util.ByteArrayOutputStream2; /** Output. * *

    - * Implements {@link javax.servlet.ServletOutputStream} from the {@link javax.servlet} package. + * Implements {@link javax.servlet.ServletOutputStream} from the javax.servlet package. *

    * A {@link ServletOutputStream} implementation that writes content * to a {@link AbstractGenerator}. The class is designed to be reused diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java b/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java index e9b346356b3..d31219d1bac 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java @@ -72,15 +72,15 @@ import org.eclipse.jetty.util.log.Log; /* ------------------------------------------------------------ */ /** Jetty Request. *

    - * Implements {@link javax.servlet.http.HttpServletRequest} from the {@link javax.servlet.http} package. + * Implements {@link javax.servlet.http.HttpServletRequest} from the javax.servlet.http package. *

    *

    * The standard interface of mostly getters, * is extended with setters so that the request is mutable by the handlers that it is * passed to. This allows the request object to be as lightweight as possible and not - * actually implement any significant behaviour. For example

      + * actually implement any significant behavior. For example
        * - *
      • The {@link Request#getContextPath()} method will return null, until the requeset has been + *
      • The {@link Request#getContextPath()} method will return null, until the request has been * passed to a {@link ContextHandler} which matches the {@link Request#getPathInfo()} with a context * path and calls {@link Request#setContextPath(String)} as a result.
        • * diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/Response.java b/jetty-server/src/main/java/org/eclipse/jetty/server/Response.java index 02634931906..3ca74a09417 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/Response.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/Response.java @@ -44,14 +44,10 @@ import org.eclipse.jetty.util.StringUtil; import org.eclipse.jetty.util.URIUtil; import org.eclipse.jetty.util.log.Log; -/* ------------------------------------------------------------ */ /** Response. *

        - * Implements {@link javax.servlet.HttpServletResponse} from the {@link javax.servlet} package. + * Implements {@link javax.servlet.http.HttpServletResponse} from the javax.servlet.http package. *

        - * - * - * */ public class Response implements HttpServletResponse { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java index 6bdb9539aa8..b355639596e 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java @@ -1434,7 +1434,7 @@ public class ContextHandler extends ScopedHandler implements Attributes, Server. /** Context. *

        * A partial implementation of {@link javax.servlet.ServletContext}. - * A complete implementation is provided by the derived {@link org.eclipse.jetty.servlet.ServletContextHandler.Context}. + * A complete implementation is provided by the derived {@link ContextHandler}. *

        * * diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandlerCollection.java b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandlerCollection.java index c64174982d7..4972bcf586a 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandlerCollection.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandlerCollection.java @@ -266,8 +266,6 @@ public class ContextHandlerCollection extends HandlerCollection /** Add a context handler. * @param contextPath The context path to add * @return the ContextHandler just added - * @throws IllegalAccessException - * @throws InstantiationException */ public ContextHandler addContext(String contextPath,String resourceBase) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/HandlerList.java b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/HandlerList.java index 5da091fb214..35b067f5088 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/HandlerList.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/HandlerList.java @@ -24,7 +24,7 @@ import org.eclipse.jetty.server.Request; /* ------------------------------------------------------------ */ /** HandlerList. - * This extension of {@link org.eclipse.jetty.server.server.handler.HandlerCollection} will call + * This extension of {@link HandlerCollection} will call * each contained handler in turn until either an exception is thrown, the response * is committed or a positive response status is set. */ diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ProxyHandler.java b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ProxyHandler.java index 940f1d50b43..a1f28329557 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ProxyHandler.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ProxyHandler.java @@ -32,7 +32,7 @@ import org.eclipse.jetty.util.log.Logger; import org.eclipse.jetty.util.thread.ThreadPool; /** - *

        Implementation of a tunnelling proxy that supports HTTP CONNECT and transparent proxy.

        + *

        Implementation of a tunneling proxy that supports HTTP CONNECT and transparent proxy.

        *

        To work as CONNECT proxy, objects of this class must be instantiated using the no-arguments * constructor, since the remote server information will be present in the CONNECT URI.

        *

        To work as transparent proxy, objects of this class must be instantiated using the string diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/nio/SelectChannelConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/nio/SelectChannelConnector.java index 8c103d8da20..32e8bdde643 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/nio/SelectChannelConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/nio/SelectChannelConnector.java @@ -262,7 +262,7 @@ public class SelectChannelConnector extends AbstractNIOConnector * than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections * in order to gracefully handle high load situations. * @param lowResourcesMaxIdleTime the period in ms that a connection is allowed to be idle when resources are low. - * @see #setMaxIdleTime(long) + * @see #setMaxIdleTime(int) */ @Override public void setLowResourcesMaxIdleTime(int lowResourcesMaxIdleTime) diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java index f18c46fad7a..3e353578a60 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java @@ -263,7 +263,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /* ------------------------------------------------------------ */ /** - * @see getSessionsMax() + * @see #getSessionsMax() */ @Deprecated public int getMaxSessions() @@ -301,7 +301,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /* ------------------------------------------------------------ */ /** - * @see getSessionsMin() + * @deprecated always returns 0. no replacement available. */ @Deprecated public int getMinSessions() @@ -367,7 +367,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /* ------------------------------------------------------------ */ /** - * @deprecated. Need to review if it is needed. + * @deprecated Need to review if it is needed. */ public abstract Map getSessionMap(); @@ -448,7 +448,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /* ------------------------------------------------------------ */ /** - * @see statsReset() + * @see #statsReset() */ @Deprecated public void resetStats() @@ -792,13 +792,11 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement public Session getSession(); } - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ /* ------------------------------------------------------------ */ /** * *

        - * Implements {@link javax.servlet.HttpSession} from the {@link javax.servlet} package. + * Implements {@link javax.servlet.http.HttpSession} from the javax.servlet package. *

        * * diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionIdManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionIdManager.java index bf227dd8859..830cbfc7c5c 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionIdManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionIdManager.java @@ -48,6 +48,7 @@ public class HashSessionIdManager extends AbstractSessionIdManager /* ------------------------------------------------------------ */ /** Get the session ID with any worker ID. * + * @param clusterId * @param request * @return sessionId plus any worker ID. */ @@ -66,7 +67,7 @@ public class HashSessionIdManager extends AbstractSessionIdManager /* ------------------------------------------------------------ */ /** Get the session ID without any worker ID. * - * @param request + * @param nodeId the node id * @return sessionId without any worker ID. */ public String getClusterId(String nodeId) @@ -94,8 +95,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager } /* ------------------------------------------------------------ */ - /* - * @see org.eclipse.jetty.server.server.SessionManager.MetaManager#idInUse(java.lang.String) + /** + * @see SessionIdManager#idInUse(String) */ public boolean idInUse(String id) { @@ -103,8 +104,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager } /* ------------------------------------------------------------ */ - /* - * @see org.eclipse.jetty.server.server.SessionManager.MetaManager#addSession(javax.servlet.http.HttpSession) + /** + * @see SessionIdManager#addSession(HttpSession) */ public void addSession(HttpSession session) { @@ -112,8 +113,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager } /* ------------------------------------------------------------ */ - /* - * @see org.eclipse.jetty.server.server.SessionManager.MetaManager#addSession(javax.servlet.http.HttpSession) + /** + * @see SessionIdManager#removeSession(HttpSession) */ public void removeSession(HttpSession session) { @@ -121,8 +122,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager } /* ------------------------------------------------------------ */ - /* - * @see org.eclipse.jetty.server.server.SessionManager.MetaManager#invalidateAll(java.lang.String) + /** + * @see SessionIdManager#invalidateAll(String) */ public void invalidateAll(String id) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java index 50633acbc41..6ee37caebcc 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java @@ -112,7 +112,7 @@ public class JDBCSessionIdManager extends AbstractSessionIdManager * depending on the way the db stores identifiers. * * @param identifier - * @return + * @return the converted identifier */ public String convertIdentifier (String identifier) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java index d89408ea4fa..5494fe1617d 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java @@ -440,7 +440,7 @@ public class JDBCSessionManager extends AbstractSessionManager * This could be used eg with a JMS backplane to notify nodes * that the session has changed and to delete the session from * the node's cache, and re-read it from the database. - * @param idInCluster + * @param session */ public void cacheInvalidate (Session session) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSelectChannelConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSelectChannelConnector.java index f40159f08ad..101787f828b 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSelectChannelConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSelectChannelConnector.java @@ -471,7 +471,6 @@ public class SslSelectChannelConnector extends SelectChannelConnector implements /* ------------------------------------------------------------ */ /** - * @throws Exception * @see org.eclipse.jetty.server.ssl.SslConnector#setSslContext(javax.net.ssl.SSLContext) */ public SSLContext getSslContext() diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java index 3f2bbe67e50..ab90485b602 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java @@ -557,7 +557,6 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** - * @throws Exception * @see org.eclipse.jetty.server.ssl.SslConnector#setSslContext(javax.net.ssl.SSLContext) */ public SSLContext getSslContext() @@ -578,7 +577,7 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** * Set the value of the _wantClientAuth property. This property is used when - * {@link #newServerSocket(SocketAddress, int) opening server sockets}. + * {@link #newServerSocket(String, int, int) opening server sockets}. * * @param wantClientAuth true iff we want client certificate authentication. * @see SSLServerSocket#setWantClientAuth @@ -667,7 +666,8 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** * Unsupported. - * @see org.eclipse.jetty.server.ssl.SslConnector#getAlgorithm() + * + * @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past) */ public String getAlgorithm() { @@ -677,7 +677,8 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** * Unsupported. - * @see org.eclipse.jetty.server.ssl.SslConnector#setAlgorithm(java.lang.String) + * + * @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past) */ public void setAlgorithm(String algorithm) { diff --git a/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java b/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java index 2ab4d3c99b6..79bf1a3f774 100644 --- a/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java +++ b/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java @@ -24,7 +24,7 @@ import junit.framework.TestCase; import org.eclipse.jetty.server.handler.AbstractHandler; /** - * Test {@link AbstractConnector#checkForwardedHeaders(org.eclipse.io.EndPoint, Request)}. + * Test {@link AbstractConnector#checkForwardedHeaders(org.eclipse.jetty.io.EndPoint, Request)}. */ public class CheckReverseProxyHeadersTest extends TestCase { diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/Scanner.java b/jetty-util/src/main/java/org/eclipse/jetty/util/Scanner.java index 5523249da51..0cacc83b117 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/Scanner.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/Scanner.java @@ -120,7 +120,7 @@ public class Scanner /** * Get the location of the directory to scan - * @return the first directory (of {@link #getScanDirs(List)} being scanned) + * @return the first directory (of {@link #getScanDirs()} being scanned) * @deprecated use getScanDirs() instead */ @Deprecated diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/UrlEncoded.java b/jetty-util/src/main/java/org/eclipse/jetty/util/UrlEncoded.java index b5ad7f4f09b..6b5729363c5 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/UrlEncoded.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/UrlEncoded.java @@ -241,7 +241,7 @@ public class UrlEncoded extends MultiMap * @param raw the byte[] containing the encoded parameters * @param offset the offset within raw to decode from * @param length the length of the section to decode - * @param map the {@link MultiMap} to use for decoding + * @param map the {@link MultiMap} to populate */ public static void decodeUtf8To(byte[] raw,int offset, int length, MultiMap map) { @@ -250,7 +250,11 @@ public class UrlEncoded extends MultiMap /* -------------------------------------------------------------- */ /** Decoded parameters to Map. - * @param data the byte[] containing the encoded parameters + * @param raw the byte[] containing the encoded parameters + * @param offset the offset within raw to decode from + * @param length the length of the section to decode + * @param map the {@link MultiMap} to populate + * @param buffer the buffer to decode into */ public static void decodeUtf8To(byte[] raw,int offset, int length, MultiMap map,Utf8StringBuilder buffer) { diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java b/jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java index 691b8839d21..d96c04012aa 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java @@ -26,7 +26,6 @@ public interface Logger /** * Formats and logs at warn level. * @param msg the formatting string - * @param arg the first argument * @param args the optional arguments */ public void warn(String msg, Object... args); @@ -47,7 +46,6 @@ public interface Logger /** * Formats and logs at info level. * @param msg the formatting string - * @param arg the first argument * @param args the optional arguments */ public void info(String msg, Object... args); @@ -79,7 +77,6 @@ public interface Logger /** * Formats and logs at debug level. * @param msg the formatting string - * @param arg the first argument * @param args the optional arguments */ public void debug(String msg, Object... args); diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/resource/JarFileResource.java b/jetty-util/src/main/java/org/eclipse/jetty/util/resource/JarFileResource.java index aa97c535053..dc933bafb76 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/resource/JarFileResource.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/resource/JarFileResource.java @@ -315,7 +315,7 @@ class JarFileResource extends JarResource * Take a Resource that possibly might use URLConnection caching * and turn it into one that doesn't. * @param resource - * @return + * @return the non-caching resource */ public static Resource getNonCachingResource (Resource resource) { @@ -331,9 +331,9 @@ class JarFileResource extends JarResource /** * Check if this jar:file: resource is contained in the - * named resource. Eg jar:file:///a/b/c/foo.jar!/x.html isContainedIn file:///a/b/c/foo.jar + * named resource. Eg jar:file:///a/b/c/foo.jar!/x.html isContainedIn file:///a/b/c/foo.jar * @param resource - * @return + * @return true if resource is contained in the named resource * @throws MalformedURLException */ @Override diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/statistic/SampleStatistic.java b/jetty-util/src/main/java/org/eclipse/jetty/util/statistic/SampleStatistic.java index cc0edea8dbb..fbdb422b0b3 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/statistic/SampleStatistic.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/statistic/SampleStatistic.java @@ -24,7 +24,7 @@ import java.util.concurrent.atomic.AtomicLong; * deviation of continuous sequence of samples. *

        * Calculates estimates of mean, variance, and standard deviation - * characteristics of a sample using a non synchronised + * characteristics of a sample using a non synchronized * approximation of the on-line algorithm presented * in Donald Knuth's Art of Computer Programming, Volume 2, * Seminumerical Algorithms, 3rd edition, page 232, @@ -73,7 +73,7 @@ public class SampleStatistic /* ------------------------------------------------------------ */ /** - * @return + * @return the max value */ public long getMax() {