From 9e6c8eade16269567dd72f94c24413d25db67442 Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Wed, 22 Apr 2015 12:43:22 -0700 Subject: [PATCH] 464727 - Update Javadoc for Java 8 DocLint --- .../main/java/org/eclipse/jetty/http2/HTTP2Session.java | 2 +- .../src/main/java/org/eclipse/jetty/http2/IStream.java | 4 ++-- .../src/main/java/org/eclipse/jetty/http2/api/Session.java | 4 ++-- .../jetty/http2/api/server/ServerSessionListener.java | 2 +- .../java/org/eclipse/jetty/http2/parser/PrefaceParser.java | 2 +- .../java/org/eclipse/jetty/http2/parser/ServerParser.java | 2 +- .../org/eclipse/jetty/http2/hpack/MetaDataBuilder.java | 7 ++----- 7 files changed, 10 insertions(+), 13 deletions(-) diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Session.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Session.java index 54608fdff69..6356701c23e 100644 --- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Session.java +++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Session.java @@ -323,7 +323,7 @@ public abstract class HTTP2Session implements ISession, Parser.Listener * * NOT_CLOSED: we move to REMOTELY_CLOSED and queue a disconnect, so * that the content of the queue is written, and then the connection * closed. We notify the application after being terminated. - * See {@link HTTP2Session.ControlEntry#succeeded()} + * See HTTP2Session.ControlEntry#succeeded() * * * In all other cases, we do nothing since other methods are already * performing their actions. diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/IStream.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/IStream.java index 47408f4c834..e041f5477b4 100644 --- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/IStream.java +++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/IStream.java @@ -43,13 +43,13 @@ public interface IStream extends Stream, Closeable public ISession getSession(); /** - * @return the {@link Listener} associated with this stream + * @return the {@link org.eclipse.jetty.http2.api.Stream.Listener} associated with this stream * @see #setListener(Listener) */ public Listener getListener(); /** - * @param listener the {@link Listener} associated with this stream + * @param listener the {@link org.eclipse.jetty.http2.api.Stream.Listener} associated with this stream * @see #getListener() */ public void setListener(Listener listener); diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/Session.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/Session.java index ce2ee9ef10c..4b8d05393d0 100644 --- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/Session.java +++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/Session.java @@ -36,7 +36,7 @@ import org.eclipse.jetty.util.Promise; *
  * Session session = ...;
  * HeadersFrame frame = ...;
- * Promise promise = ...
+ * Promise<Stream> promise = ...
  * session.newStream(frame, promise, new Stream.Listener.Adapter()
  * {
  *     public void onHeaders(Stream stream, HeadersFrame frame)
@@ -167,7 +167,7 @@ public interface Session
          *
          * @param session the session
          * @param frame   the RST_STREAM frame received
-         * @see {@link Stream.Listener#onReset(Stream, ResetFrame)}
+         * @see Stream.Listener#onReset(Stream, ResetFrame)
          */
         public void onReset(Session session, ResetFrame frame);
 
diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/server/ServerSessionListener.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/server/ServerSessionListener.java
index e1228742fe1..b563cc4e0c6 100644
--- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/server/ServerSessionListener.java
+++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/api/server/ServerSessionListener.java
@@ -21,7 +21,7 @@ package org.eclipse.jetty.http2.api.server;
 import org.eclipse.jetty.http2.api.Session;
 
 /**
- * 

Server-side extension of {@link Session.Listener} that exposes additional events.

+ *

Server-side extension of {@link org.eclipse.jetty.http2.api.Session.Listener} that exposes additional events.

*/ public interface ServerSessionListener extends Session.Listener { diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/PrefaceParser.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/PrefaceParser.java index 3739b81a904..f511f0891b6 100644 --- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/PrefaceParser.java +++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/PrefaceParser.java @@ -40,7 +40,7 @@ public class PrefaceParser /* ------------------------------------------------------------ */ /** Unsafe upgrade is an unofficial upgrade from HTTP/1.0 to HTTP/2.0 - * initiated when a the {@link HttpConnection} sees a PRI * HTTP/2.0 prefix + * initiated when a the org.eclipse.jetty.server.HttpConnection sees a PRI * HTTP/2.0 prefix * that indicates a HTTP/2.0 client is attempting a h2c direct connection. * This is not a standard HTTP/1.1 Upgrade path. */ diff --git a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/ServerParser.java b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/ServerParser.java index 1b798267857..5338b0f878d 100644 --- a/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/ServerParser.java +++ b/jetty-http2/http2-common/src/main/java/org/eclipse/jetty/http2/parser/ServerParser.java @@ -43,7 +43,7 @@ public class ServerParser extends Parser /* ------------------------------------------------------------ */ /** Unsafe upgrade is an unofficial upgrade from HTTP/1.0 to HTTP/2.0 - * initiated when a the {@link HttpConnection} sees a PRI * HTTP/2.0 prefix + * initiated when a the org.eclipse.jetty.server.HttpConnection sees a PRI * HTTP/2.0 prefix * that indicates a HTTP/2.0 client is attempting a h2c direct connection. * This is not a standard HTTP/1.1 Upgrade path. */ diff --git a/jetty-http2/http2-hpack/src/main/java/org/eclipse/jetty/http2/hpack/MetaDataBuilder.java b/jetty-http2/http2-hpack/src/main/java/org/eclipse/jetty/http2/hpack/MetaDataBuilder.java index 028c63db1b8..8e81dccaf83 100644 --- a/jetty-http2/http2-hpack/src/main/java/org/eclipse/jetty/http2/hpack/MetaDataBuilder.java +++ b/jetty-http2/http2-hpack/src/main/java/org/eclipse/jetty/http2/hpack/MetaDataBuilder.java @@ -29,9 +29,6 @@ import org.eclipse.jetty.http.HttpStatus; import org.eclipse.jetty.http.HttpVersion; import org.eclipse.jetty.http.MetaData; -/* -------------------------------------------------------- */ -/* -------------------------------------------------------- */ -/* -------------------------------------------------------- */ public class MetaDataBuilder { private final int _maxSize; @@ -173,8 +170,8 @@ public class MetaDataBuilder /* ------------------------------------------------------------ */ /** Check that the max size will not be exceeded. - * @param length - * @param huffmanName + * @param length the length + * @param huffman the huffman name */ public void checkSize(int length, boolean huffman) {