You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2021/11/19 12:30:09 UTC
[tomcat] branch 8.5.x updated: Javadoc clean-up including missing @since tags
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/8.5.x by this push:
new b5efe6d Javadoc clean-up including missing @since tags
b5efe6d is described below
commit b5efe6dfa9758bb81fca1bc51cc61118699ea264
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Nov 19 12:27:44 2021 +0000
Javadoc clean-up including missing @since tags
---
java/javax/servlet/FilterChain.java | 3 +--
java/javax/servlet/FilterConfig.java | 1 -
java/javax/servlet/RequestDispatcher.java | 1 -
java/javax/servlet/ServletContext.java | 1 +
java/javax/servlet/ServletContextAttributeEvent.java | 1 +
java/javax/servlet/ServletContextAttributeListener.java | 3 ++-
java/javax/servlet/ServletContextEvent.java | 1 +
java/javax/servlet/ServletContextListener.java | 2 +-
java/javax/servlet/ServletRequest.java | 2 ++
java/javax/servlet/ServletRequestWrapper.java | 4 +++-
java/javax/servlet/ServletResponse.java | 1 +
java/javax/servlet/http/HttpServletRequestWrapper.java | 2 ++
java/javax/servlet/http/HttpServletResponse.java | 2 +-
java/javax/servlet/http/HttpUpgradeHandler.java | 2 --
14 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/java/javax/servlet/FilterChain.java b/java/javax/servlet/FilterChain.java
index 09fe64d..06c67b8 100644
--- a/java/javax/servlet/FilterChain.java
+++ b/java/javax/servlet/FilterChain.java
@@ -27,8 +27,7 @@ import java.io.IOException;
*
* @see Filter
* @since Servlet 2.3
- **/
-
+ */
public interface FilterChain {
/**
diff --git a/java/javax/servlet/FilterConfig.java b/java/javax/servlet/FilterConfig.java
index 3af26ec..3988a27 100644
--- a/java/javax/servlet/FilterConfig.java
+++ b/java/javax/servlet/FilterConfig.java
@@ -19,7 +19,6 @@ package javax.servlet;
import java.util.Enumeration;
/**
- *
* A filter configuration object used by a servlet container to pass information
* to a filter during initialization.
*
diff --git a/java/javax/servlet/RequestDispatcher.java b/java/javax/servlet/RequestDispatcher.java
index 99ceeef..0f945b7 100644
--- a/java/javax/servlet/RequestDispatcher.java
+++ b/java/javax/servlet/RequestDispatcher.java
@@ -32,7 +32,6 @@ import java.io.IOException;
* @see ServletContext#getRequestDispatcher(java.lang.String)
* @see ServletContext#getNamedDispatcher(java.lang.String)
* @see ServletRequest#getRequestDispatcher(java.lang.String)
- *
*/
public interface RequestDispatcher {
diff --git a/java/javax/servlet/ServletContext.java b/java/javax/servlet/ServletContext.java
index 8858b8a..05c91e5 100644
--- a/java/javax/servlet/ServletContext.java
+++ b/java/javax/servlet/ServletContext.java
@@ -523,6 +523,7 @@ public interface ServletContext {
* method with an attribute name to get the value of an attribute.
*
* @return an <code>Enumeration</code> of attribute names
+ *
* @see #getAttribute
*/
public Enumeration<String> getAttributeNames();
diff --git a/java/javax/servlet/ServletContextAttributeEvent.java b/java/javax/servlet/ServletContextAttributeEvent.java
index 888aaf2..cb2cd78 100644
--- a/java/javax/servlet/ServletContextAttributeEvent.java
+++ b/java/javax/servlet/ServletContextAttributeEvent.java
@@ -21,6 +21,7 @@ package javax.servlet;
* the servlet context of a web application.
*
* @see ServletContextAttributeListener
+ *
* @since Servlet 2.3
*/
public class ServletContextAttributeEvent extends ServletContextEvent {
diff --git a/java/javax/servlet/ServletContextAttributeListener.java b/java/javax/servlet/ServletContextAttributeListener.java
index 5e538f5..f3fc6a2 100644
--- a/java/javax/servlet/ServletContextAttributeListener.java
+++ b/java/javax/servlet/ServletContextAttributeListener.java
@@ -25,10 +25,11 @@ import java.util.EventListener;
* deployment descriptor for the web application.
*
* @see ServletContextAttributeEvent
+ *
* @since Servlet 2.3
*/
-
public interface ServletContextAttributeListener extends EventListener {
+
/**
* Notification that a new attribute was added to the servlet context.
* Called after the attribute is added.
diff --git a/java/javax/servlet/ServletContextEvent.java b/java/javax/servlet/ServletContextEvent.java
index fc16312..ac0a53c 100644
--- a/java/javax/servlet/ServletContextEvent.java
+++ b/java/javax/servlet/ServletContextEvent.java
@@ -21,6 +21,7 @@ package javax.servlet;
* context of a web application.
*
* @see ServletContextListener
+ *
* @since Servlet 2.3
*/
public class ServletContextEvent extends java.util.EventObject {
diff --git a/java/javax/servlet/ServletContextListener.java b/java/javax/servlet/ServletContextListener.java
index 2ba0af9..f0141ad 100644
--- a/java/javax/servlet/ServletContextListener.java
+++ b/java/javax/servlet/ServletContextListener.java
@@ -25,9 +25,9 @@ import java.util.EventListener;
* deployment descriptor for the web application.
*
* @see ServletContextEvent
+ *
* @since Servlet 2.3
*/
-
public interface ServletContextListener extends EventListener {
/**
diff --git a/java/javax/servlet/ServletRequest.java b/java/javax/servlet/ServletRequest.java
index ae66cb2..562a7e4 100644
--- a/java/javax/servlet/ServletRequest.java
+++ b/java/javax/servlet/ServletRequest.java
@@ -411,6 +411,7 @@ public interface ServletRequest {
* proxy that sent the request.
*
* @return an integer specifying the port number
+ *
* @since Servlet 2.4
*/
public int getRemotePort();
@@ -440,6 +441,7 @@ public interface ServletRequest {
* the request was received.
*
* @return an integer specifying the port number
+ *
* @since Servlet 2.4
*/
public int getLocalPort();
diff --git a/java/javax/servlet/ServletRequestWrapper.java b/java/javax/servlet/ServletRequestWrapper.java
index f5a51b4..cf3b2d2 100644
--- a/java/javax/servlet/ServletRequestWrapper.java
+++ b/java/javax/servlet/ServletRequestWrapper.java
@@ -29,8 +29,9 @@ import java.util.ResourceBundle;
* class implements the Wrapper or Decorator pattern. Methods default to calling
* through to the wrapped request object.
*
- * @since Servlet 2.3
* @see javax.servlet.ServletRequest
+ *
+ * @since Servlet 2.3
*/
public class ServletRequestWrapper implements ServletRequest {
private static final String LSTRING_FILE = "javax.servlet.LocalStrings";
@@ -63,6 +64,7 @@ public class ServletRequestWrapper implements ServletRequest {
/**
* Sets the request object being wrapped.
+ *
* @param request The new wrapped request.
*
* @throws IllegalArgumentException if the request is null.
diff --git a/java/javax/servlet/ServletResponse.java b/java/javax/servlet/ServletResponse.java
index 81127d0..5655f66 100644
--- a/java/javax/servlet/ServletResponse.java
+++ b/java/javax/servlet/ServletResponse.java
@@ -272,6 +272,7 @@ public interface ServletResponse {
* @see #getBufferSize
* @see #isCommitted
* @see #reset
+ *
* @since Servlet 2.3
*/
public void resetBuffer();
diff --git a/java/javax/servlet/http/HttpServletRequestWrapper.java b/java/javax/servlet/http/HttpServletRequestWrapper.java
index 4eb6de8..d88e9d1 100644
--- a/java/javax/servlet/http/HttpServletRequestWrapper.java
+++ b/java/javax/servlet/http/HttpServletRequestWrapper.java
@@ -243,6 +243,8 @@ public class HttpServletRequestWrapper extends ServletRequestWrapper implements
/**
* The default behavior of this method is to call changeSessionId() on the
* wrapped request object.
+ *
+ * @since Servlet 3.1
*/
@Override
public String changeSessionId() {
diff --git a/java/javax/servlet/http/HttpServletResponse.java b/java/javax/servlet/http/HttpServletResponse.java
index 0d48e7f..0588a91 100644
--- a/java/javax/servlet/http/HttpServletResponse.java
+++ b/java/javax/servlet/http/HttpServletResponse.java
@@ -344,7 +344,7 @@ public interface HttpServletResponse extends ServletResponse {
public Collection<String> getHeaderNames();
/*
- * Server status codes; see RFC 2068.
+ * Server status codes; see RFC 7231.
*/
/**
diff --git a/java/javax/servlet/http/HttpUpgradeHandler.java b/java/javax/servlet/http/HttpUpgradeHandler.java
index 095200c..be8a60c 100644
--- a/java/javax/servlet/http/HttpUpgradeHandler.java
+++ b/java/javax/servlet/http/HttpUpgradeHandler.java
@@ -30,8 +30,6 @@ public interface HttpUpgradeHandler {
* the container to the {@link HttpUpgradeHandler}.
*
* @param connection The connection that has been upgraded
- *
- * @since Servlet 3.1
*/
void init(WebConnection connection);
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org