From b378049d1aaac48efb61b51469167b1428698abb Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Wed, 14 Aug 2013 12:40:09 -0700 Subject: [PATCH] Fixing malformed Javadoc warnings in jetty-server --- .../jetty/server/ForwardedRequestCustomizer.java | 10 +--------- .../org/eclipse/jetty/server/NetworkConnector.java | 1 - .../java/org/eclipse/jetty/server/QueuedHttpInput.java | 4 ++-- .../java/org/eclipse/jetty/server/ServerConnector.java | 2 +- .../jetty/server/session/AbstractSessionManager.java | 1 - .../jetty/server/session/HashSessionManager.java | 4 ++-- .../jetty/server/session/JDBCSessionManager.java | 2 +- 7 files changed, 7 insertions(+), 17 deletions(-) diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ForwardedRequestCustomizer.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ForwardedRequestCustomizer.java index 608a861d7f8..845cbc81108 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ForwardedRequestCustomizer.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ForwardedRequestCustomizer.java @@ -44,7 +44,7 @@ import org.eclipse.jetty.server.HttpConfiguration.Customizer; * the request came

*

Headers can also be defined so that forwarded SSL Session IDs and Cipher * suites may be customised

- * @see http://en.wikipedia.org/wiki/X-Forwarded-For + * @see Wikipedia: X-Forwarded-For */ public class ForwardedRequestCustomizer implements Customizer { @@ -66,7 +66,6 @@ public class ForwardedRequestCustomizer implements Customizer /* ------------------------------------------------------------ */ /** * Set a forced valued for the host header to control what is returned by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}. - * This value is only used if {@link #isForwarded()} is true. * * @param hostHeader * The value of the host header to force. @@ -90,7 +89,6 @@ public class ForwardedRequestCustomizer implements Customizer /** * @param forwardedHostHeader * The header name for forwarded hosts (default x-forwarded-host) - * @see #setForwarded(boolean) */ public void setForwardedHostHeader(String forwardedHostHeader) { @@ -100,7 +98,6 @@ public class ForwardedRequestCustomizer implements Customizer /* ------------------------------------------------------------ */ /** * @return the header name for forwarded server. - * @see #setForwarded(boolean) */ public String getForwardedServerHeader() { @@ -111,7 +108,6 @@ public class ForwardedRequestCustomizer implements Customizer /** * @param forwardedServerHeader * The header name for forwarded server (default x-forwarded-server) - * @see #setForwarded(boolean) */ public void setForwardedServerHeader(String forwardedServerHeader) { @@ -121,7 +117,6 @@ public class ForwardedRequestCustomizer implements Customizer /* ------------------------------------------------------------ */ /** * @return the forwarded for header - * @see #setForwarded(boolean) */ public String getForwardedForHeader() { @@ -132,7 +127,6 @@ public class ForwardedRequestCustomizer implements Customizer /** * @param forwardedRemoteAddressHeader * The header name for forwarded for (default x-forwarded-for) - * @see #setForwarded(boolean) */ public void setForwardedForHeader(String forwardedRemoteAddressHeader) { @@ -144,7 +138,6 @@ public class ForwardedRequestCustomizer implements Customizer * Get the forwardedProtoHeader. * * @return the forwardedProtoHeader (default X-Forwarded-For) - * @see #setForwarded(boolean) */ public String getForwardedProtoHeader() { @@ -157,7 +150,6 @@ public class ForwardedRequestCustomizer implements Customizer * * @param forwardedProtoHeader * the forwardedProtoHeader to set (default X-Forwarded-For) - * @see #setForwarded(boolean) */ public void setForwardedProtoHeader(String forwardedProtoHeader) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/NetworkConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/NetworkConnector.java index d7304d8fc32..df8ce174c62 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/NetworkConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/NetworkConnector.java @@ -39,7 +39,6 @@ public interface NetworkConnector extends Connector, AutoCloseable * (for example, to stop accepting network connections).

* Once a connector has been closed, it cannot be opened again without first * calling {@link #stop()} and it will not be active again until a subsequent call to {@link #start()} - * @throws IOException if this connector cannot be closed */ @Override void close(); diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/QueuedHttpInput.java b/jetty-server/src/main/java/org/eclipse/jetty/server/QueuedHttpInput.java index 560b72866a9..fb0c23a3fe0 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/QueuedHttpInput.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/QueuedHttpInput.java @@ -28,12 +28,12 @@ import org.eclipse.jetty.util.log.Logger; /** *

{@link QueuedHttpInput} provides an implementation of {@link ServletInputStream} for {@link HttpChannel}.

- *

{@link QueuedHttpInput} holds a queue of items passed to it by calls to {@link #content(T)}.

+ *

{@link QueuedHttpInput} holds a queue of items passed to it by calls to {@link #content(Object)}.

*

{@link QueuedHttpInput} stores the items directly; if the items contain byte buffers, it does not copy them * but simply holds references to the item, thus the caller must organize for those buffers to valid while * held by this class.

*

To assist the caller, subclasses may override methods {@link #onAsyncRead()}, - * {@link #onContentConsumed(T)} and {@link #onAllContentConsumed()} that can be implemented so that the + * {@link #onContentConsumed(Object)} and {@link #onAllContentConsumed()} that can be implemented so that the * caller will know when buffers are queued and consumed.

*/ public abstract class QueuedHttpInput extends HttpInput diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ServerConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ServerConnector.java index 8e815d9acdd..1164cf728d8 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ServerConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ServerConnector.java @@ -67,7 +67,7 @@ import org.eclipse.jetty.util.thread.Scheduler; * which are implemented to each use a NIO {@link Selector} instance to asynchronously * schedule a set of accepted connections. It is the selector thread that will call the * {@link Callback} instances passed in the {@link EndPoint#fillInterested(Callback)} or - * {@link EndPoint#write(Object, Callback, java.nio.ByteBuffer...)} methods. It is expected + * {@link EndPoint#write(Callback, java.nio.ByteBuffer...)} methods. It is expected * that these callbacks may do some non-blocking IO work, but will always dispatch to the * {@link Executor} service any blocking, long running or application tasks. *

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 53a5106d234..b13419bc211 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 @@ -416,7 +416,6 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /* ------------------------------------------------------------ */ /** - * @return if true, session cookie will be marked as secure only iff * HTTPS request. Can be overridden by setting SessionCookieConfig.setSecure(true), * in which case the session cookie will be marked as secure on both HTTPS and HTTP. */ diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionManager.java index 1c6676ac1a6..65bcf1f0713 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionManager.java @@ -83,7 +83,7 @@ public class HashSessionManager extends AbstractSessionManager /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.servlet.AbstractSessionManager#doStart() + * @see AbstractSessionManager#doStart() */ @Override public void doStart() throws Exception @@ -116,7 +116,7 @@ public class HashSessionManager extends AbstractSessionManager /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.servlet.AbstractSessionManager#doStop() + * @see AbstractSessionManager#doStop() */ @Override public void doStop() throws Exception 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 9cdae2c4761..75c40e8a4eb 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 @@ -951,7 +951,7 @@ public class JDBCSessionManager extends AbstractSessionManager /** * Insert a session into the database. * - * @param data + * @param session * @throws Exception */ protected void storeSession (Session session)