Re: (tomcat) branch main updated: Fix javadoc

2024-05-24 Thread Mark Thomas

On 24/05/2024 14:28, r...@apache.org wrote:

This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
  new 51e8165b8f Fix javadoc
51e8165b8f is described below

commit 51e8165b8feb1e9e0165e08ad103f00ba21a7e96
Author: remm 
AuthorDate: Fri May 24 15:27:39 2024 +0200

 Fix javadoc


Tx.

Mark


---
  java/org/apache/catalina/servlets/WebdavServlet.java | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/catalina/servlets/WebdavServlet.java 
b/java/org/apache/catalina/servlets/WebdavServlet.java
index bff746db1e..60076f8b27 100644
--- a/java/org/apache/catalina/servlets/WebdavServlet.java
+++ b/java/org/apache/catalina/servlets/WebdavServlet.java
@@ -134,7 +134,7 @@ import org.xml.sax.SAXException;
   * 
   * There are some known limitations of this Servlet due to it not 
implementing the PROPPATCH method. Details of these
   * limitations and progress towards addressing them are being tracked under
- * https://bz.apache.org/bugzilla/show_bug.cgi?id=69046>bug 
69046.
+ * https://bz.apache.org/bugzilla/show_bug.cgi?id=69046";>bug 
69046.
   * 
   *
   * @see https://tools.ietf.org/html/rfc4918";>RFC 4918


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



(tomcat) branch main updated: Fix javadoc

2024-05-24 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 51e8165b8f Fix javadoc
51e8165b8f is described below

commit 51e8165b8feb1e9e0165e08ad103f00ba21a7e96
Author: remm 
AuthorDate: Fri May 24 15:27:39 2024 +0200

Fix javadoc
---
 java/org/apache/catalina/servlets/WebdavServlet.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/catalina/servlets/WebdavServlet.java 
b/java/org/apache/catalina/servlets/WebdavServlet.java
index bff746db1e..60076f8b27 100644
--- a/java/org/apache/catalina/servlets/WebdavServlet.java
+++ b/java/org/apache/catalina/servlets/WebdavServlet.java
@@ -134,7 +134,7 @@ import org.xml.sax.SAXException;
  * 
  * There are some known limitations of this Servlet due to it not implementing 
the PROPPATCH method. Details of these
  * limitations and progress towards addressing them are being tracked under
- * https://bz.apache.org/bugzilla/show_bug.cgi?id=69046>bug 
69046.
+ * https://bz.apache.org/bugzilla/show_bug.cgi?id=69046";>bug 
69046.
  * 
  *
  * @see https://tools.ietf.org/html/rfc4918";>RFC 4918


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



(tomcat) branch main updated: Fix javadoc

2024-02-05 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new df1acafcae Fix javadoc
df1acafcae is described below

commit df1acafcae620d40d9c29376125039505f42d9d1
Author: remm 
AuthorDate: Mon Feb 5 12:57:26 2024 +0100

Fix javadoc
---
 java/org/apache/catalina/filters/CsrfPreventionFilter.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/catalina/filters/CsrfPreventionFilter.java 
b/java/org/apache/catalina/filters/CsrfPreventionFilter.java
index 4150ab0d92..2d65bb3544 100644
--- a/java/org/apache/catalina/filters/CsrfPreventionFilter.java
+++ b/java/org/apache/catalina/filters/CsrfPreventionFilter.java
@@ -225,7 +225,7 @@ public class CsrfPreventionFilter extends 
CsrfPreventionFilterBase {
  */bar/*.
  *
  * @return A Predicate which can match the specified pattern, or
- * >null if the pattern is null or blank.
+ * null if the pattern is null or blank.
  */
 protected static Predicate createNoNoncePredicate(ServletContext 
context, String pattern) {
 if (null == pattern || 0 == pattern.trim().length()) {


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix javadoc warning (for branches built with Java 11)

2023-10-09 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 6a96bcadb9 Fix javadoc warning (for branches built with Java 11)
6a96bcadb9 is described below

commit 6a96bcadb934051bd3054fb21989caf868106c29
Author: remm 
AuthorDate: Mon Oct 9 23:29:08 2023 +0200

Fix javadoc warning (for branches built with Java 11)
---
 java/org/apache/catalina/security/TLSCertificateReloadListener.java | 1 -
 1 file changed, 1 deletion(-)

diff --git 
a/java/org/apache/catalina/security/TLSCertificateReloadListener.java 
b/java/org/apache/catalina/security/TLSCertificateReloadListener.java
index d9fe20f462..0596732575 100644
--- a/java/org/apache/catalina/security/TLSCertificateReloadListener.java
+++ b/java/org/apache/catalina/security/TLSCertificateReloadListener.java
@@ -40,7 +40,6 @@ import org.apache.tomcat.util.res.StringManager;
  * 
  * This listener does NOT re-read the Tomcat configuration from 
server.xml. If you make changes to server.xml you
  * must restart the Tomcat process to pick up those changes.
- * 
  */
 public class TLSCertificateReloadListener implements LifecycleListener {
 


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc

2023-10-09 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 7175eb5089 Fix Javadoc
7175eb5089 is described below

commit 7175eb5089abc66550f1242132bba69abb63e553
Author: Mark Thomas 
AuthorDate: Mon Oct 9 17:31:09 2023 -0300

Fix Javadoc
---
 java/org/apache/catalina/valves/FilterValve.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/catalina/valves/FilterValve.java 
b/java/org/apache/catalina/valves/FilterValve.java
index d3f3da5f1b..2ac4ace086 100644
--- a/java/org/apache/catalina/valves/FilterValve.java
+++ b/java/org/apache/catalina/valves/FilterValve.java
@@ -59,7 +59,7 @@ import 
org.apache.tomcat.util.threads.ScheduledThreadPoolExecutor;
  * will be thrown.
  * 
  *
- * @see Valve
+ * @see org.apache.catalina.Valve
  * @see Filter
  */
 public class FilterValve extends ValveBase implements FilterConfig {


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix javadoc and documentation.

2023-08-31 Thread lihan
This is an automated email from the ASF dual-hosted git repository.

lihan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new ca095d52c9 Fix javadoc and documentation.
ca095d52c9 is described below

commit ca095d52c98c2e25005990a9ef02240a823f0334
Author: lihan 
AuthorDate: Fri Sep 1 10:43:45 2023 +0800

Fix javadoc and documentation.

Update the default value of 'socket.processorCache' and 'socket.eventCache' 
in the documentation and javadoc. And remove 'socket.keyCache' from the AJP 
documentation.
---
 java/org/apache/tomcat/util/net/SocketProperties.java |  8 
 webapps/docs/config/ajp.xml   | 13 +++--
 webapps/docs/config/http.xml  |  2 +-
 3 files changed, 8 insertions(+), 15 deletions(-)

diff --git a/java/org/apache/tomcat/util/net/SocketProperties.java 
b/java/org/apache/tomcat/util/net/SocketProperties.java
index 1cdb2c6302..b91d54f0e2 100644
--- a/java/org/apache/tomcat/util/net/SocketProperties.java
+++ b/java/org/apache/tomcat/util/net/SocketProperties.java
@@ -36,7 +36,7 @@ public class SocketProperties {
 /**
  * Enable/disable socket processor cache, this bounded cache stores
  * SocketProcessor objects to reduce GC
- * Default is 500
+ * Default is 0
  * -1 is unlimited
  * 0 is disabled
  */
@@ -45,7 +45,7 @@ public class SocketProperties {
 /**
  * Enable/disable poller event cache, this bounded cache stores
  * PollerEvent objects to reduce GC for the poller
- * Default is 500
+ * Default is 0
  * -1 is unlimited
  * 0 is disabled
  * >0 the max number of objects to keep in cache.
@@ -78,13 +78,13 @@ public class SocketProperties {
 
 /**
  * The application read buffer size in bytes.
- * Default value is rxBufSize
+ * Default value is 8192
  */
 protected int appReadBufSize = 8192;
 
 /**
  * The application write buffer size in bytes
- * Default value is txBufSize
+ * Default value is 8192
  */
 protected int appWriteBufSize = 8192;
 
diff --git a/webapps/docs/config/ajp.xml b/webapps/docs/config/ajp.xml
index 6eda243d89..bc85a734b3 100644
--- a/webapps/docs/config/ajp.xml
+++ b/webapps/docs/config/ajp.xml
@@ -720,21 +720,14 @@
   
 (int)Tomcat will cache SocketProcessor objects to reduce garbage
 collection. The integer value specifies how many objects to keep in the
-cache at most. The default is 500. Other values are
--1 for unlimited cache and 0 for no 
cache.
-  
-
-  
-(int)Tomcat will cache KeyAttachment objects to reduce garbage
-collection. The integer value specifies how many objects to keep in the
-cache at most. The default is 500. Other values are
+cache at most. The default is 0. Other values are
 -1 for unlimited cache and 0 for no 
cache.
   
 
   
 (int)Tomcat will cache PollerEvent objects to reduce garbage
 collection. The integer value specifies how many objects to keep in the
-cache at most. The default is 500. Other values are
+cache at most. The default is 0. Other values are
 -1 for unlimited cache and 0 for no 
cache.
   
 
@@ -794,7 +787,7 @@
   
 (int)Tomcat will cache SocketProcessor objects to reduce garbage
 collection. The integer value specifies how many objects to keep in the
-cache at most. The default is 500. Other values are
+cache at most. The default is 0. Other values are
 -1 for unlimited cache and 0 for no 
cache.
   
 
diff --git a/webapps/docs/config/http.xml b/webapps/docs/config/http.xml
index 5bc3c4a6e4..9cbab65964 100644
--- a/webapps/docs/config/http.xml
+++ b/webapps/docs/config/http.xml
@@ -1008,7 +1008,7 @@
   
 (int)Tomcat will cache SocketProcessor objects to reduce garbage
 collection. The integer value specifies how many objects to keep in the
-cache at most. The default is 500. Other values are
+cache at most. The default is 0. Other values are
 -1 for unlimited cache and 0 for no 
cache.
   
 


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc formatting

2023-08-02 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new ad76237a90 Fix Javadoc formatting
ad76237a90 is described below

commit ad76237a90a8aaff331e990a0d9e95f3aec1bf79
Author: Mark Thomas 
AuthorDate: Wed Aug 2 11:43:59 2023 +0100

Fix Javadoc formatting
---
 java/jakarta/el/OptionalELResolver.java | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/java/jakarta/el/OptionalELResolver.java 
b/java/jakarta/el/OptionalELResolver.java
index 95eb1c5323..c16c8f781b 100644
--- a/java/jakarta/el/OptionalELResolver.java
+++ b/java/jakarta/el/OptionalELResolver.java
@@ -38,8 +38,7 @@ import java.util.Optional;
  * {@link ELResolver} obtained from {@link ELContext#getELResolver()} with the 
following parameters:
  * 
  * The {@link ELContext} is the current context
- * The base object is the result of calling {@link Optional#get()} on the 
current base object
- * 
+ * The base object is the result of calling {@link Optional#get()} on the 
current base object
  * The property object is the current property object
  * 
  * 


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc to reflect the change in default formatter

2022-11-06 Thread lihan
This is an automated email from the ASF dual-hosted git repository.

lihan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 33b4eb58d1 Fix Javadoc to reflect the change in default formatter
33b4eb58d1 is described below

commit 33b4eb58d1bff1ca97e82dded68aa3c2a82c2943
Author: zsrv <95176387+z...@users.noreply.github.com>
AuthorDate: Sat Nov 5 16:01:00 2022 -0400

Fix Javadoc to reflect the change in default formatter
---
 java/org/apache/juli/FileHandler.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/juli/FileHandler.java 
b/java/org/apache/juli/FileHandler.java
index ca24704fc2..eb807c8c82 100644
--- a/java/org/apache/juli/FileHandler.java
+++ b/java/org/apache/juli/FileHandler.java
@@ -84,7 +84,7 @@ import java.util.regex.Pattern;
  *implementation class name for this Handler. Default value: unset
  *   formatter - The java.util.logging.Formatter
  *implementation class name for this Handler. Default value:
- *java.util.logging.SimpleFormatter
+ *org.apache.juli.OneLineFormatter
  *   maxDays - The maximum number of days to keep the log
  *files. If the specified value is <=0 then the log files
  *will be kept on the file system forever, otherwise they will be kept the


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc related build failure when building with Java 19

2022-10-20 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new d95b769b4f Fix Javadoc related build failure when building with Java 19
d95b769b4f is described below

commit d95b769b4fc5d52f63b95a9835f570d4e4e947d8
Author: Mark Thomas 
AuthorDate: Thu Oct 20 15:01:21 2022 +0100

Fix Javadoc related build failure when building with Java 19
---
 java/jakarta/el/ELResolver.java| 12 
 java/jakarta/servlet/jsp/el/ImportELResolver.java  |  7 +++
 java/jakarta/servlet/jsp/el/NotFoundELResolver.java|  7 +++
 java/jakarta/servlet/jsp/el/ScopedAttributeELResolver.java |  9 +
 java/jakarta/servlet/jsp/tagext/JspFragment.java   |  7 +++
 5 files changed, 42 insertions(+)

diff --git a/java/jakarta/el/ELResolver.java b/java/jakarta/el/ELResolver.java
index 09bb98b01f..f33d3dd25e 100644
--- a/java/jakarta/el/ELResolver.java
+++ b/java/jakarta/el/ELResolver.java
@@ -27,6 +27,9 @@ public abstract class ELResolver {
 public static final String RESOLVABLE_AT_DESIGN_TIME = 
"resolvableAtDesignTime";
 
 /**
+ * Obtain the value of the given property on the given object using the
+ * given context.
+ *
  * @param context The EL context for this evaluation
  * @param base The base object on which the property is to be found
  * @param property The property whose value is to be returned
@@ -63,6 +66,9 @@ public abstract class ELResolver {
 }
 
 /**
+ * Obtain the type of the given property on the given object using the 
given
+ * context.
+ *
  * @param context The EL context for this evaluation
  * @param base The base object on which the property is to be found
  * @param property The property whose type is to be returned
@@ -80,6 +86,9 @@ public abstract class ELResolver {
 Object property);
 
 /**
+ * Set the value of the given property on the given object using the given
+ * context.
+ *
  * @param context  The EL context for this evaluation
  * @param base The base object on which the property is to be found
  * @param property The property whose value is to be set
@@ -100,6 +109,9 @@ public abstract class ELResolver {
 Object property, Object value);
 
 /**
+ * Determine if the given property on the given object is read-only using
+ * the given context.
+ *
  * @param context The EL context for this evaluation
  * @param base The base object on which the property is to be found
  * @param property The property to be checked for read only status
diff --git a/java/jakarta/servlet/jsp/el/ImportELResolver.java 
b/java/jakarta/servlet/jsp/el/ImportELResolver.java
index 6e2cd81f75..38b3a26d7e 100644
--- a/java/jakarta/servlet/jsp/el/ImportELResolver.java
+++ b/java/jakarta/servlet/jsp/el/ImportELResolver.java
@@ -45,6 +45,13 @@ public class ImportELResolver extends ELResolver {
 AST_IDENTIFIER_KEY = key;
 }
 
+/**
+ * Default constructor.
+ */
+public ImportELResolver() {
+super();
+}
+
 @Override
 public Object getValue(ELContext context, Object base, Object property) {
 Objects.requireNonNull(context);
diff --git a/java/jakarta/servlet/jsp/el/NotFoundELResolver.java 
b/java/jakarta/servlet/jsp/el/NotFoundELResolver.java
index 23645abd6f..2849bad38b 100644
--- a/java/jakarta/servlet/jsp/el/NotFoundELResolver.java
+++ b/java/jakarta/servlet/jsp/el/NotFoundELResolver.java
@@ -34,6 +34,13 @@ public class NotFoundELResolver extends ELResolver {
 private static final String LSTRING_FILE = 
"jakarta.servlet.jsp.LocalStrings";
 private static final ResourceBundle lStrings = 
ResourceBundle.getBundle(LSTRING_FILE);
 
+/**
+ * Default constructor.
+ */
+public NotFoundELResolver() {
+super();
+}
+
 /**
  * {@inheritDoc}
  * 
diff --git a/java/jakarta/servlet/jsp/el/ScopedAttributeELResolver.java 
b/java/jakarta/servlet/jsp/el/ScopedAttributeELResolver.java
index 5908a4832c..2ec39ca7e5 100644
--- a/java/jakarta/servlet/jsp/el/ScopedAttributeELResolver.java
+++ b/java/jakarta/servlet/jsp/el/ScopedAttributeELResolver.java
@@ -24,11 +24,20 @@ import jakarta.servlet.jsp.JspContext;
 import jakarta.servlet.jsp.PageContext;
 
 /**
+ * An ELResolver for working with JSP scoped attributes which may have page,
+ * request, session or application scope.
  *
  * @since JSP 2.1
  */
 public class ScopedAttributeELResolver extends ELResolver {
 
+/**
+ * Default constructor.
+ */
+public ScopedAttributeELResolver() {
+super();
+}
+
 @Override
 public Object getValue(ELContext context, Object base, Object property) {
 Objects.requireNonNull(context);
diff --git a/java/jakarta/servlet/jsp/tagext/

[tomcat] branch main updated: Fix Javadoc

2022-10-11 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new cdcfd2029c Fix Javadoc
cdcfd2029c is described below

commit cdcfd2029cef2d8f560c39dde1df16404e76e319
Author: Mark Thomas 
AuthorDate: Tue Oct 11 21:41:12 2022 +0100

Fix Javadoc
---
 java/org/apache/tomcat/util/net/AbstractEndpoint.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/java/org/apache/tomcat/util/net/AbstractEndpoint.java 
b/java/org/apache/tomcat/util/net/AbstractEndpoint.java
index 30aa1d006c..1e473fe9a1 100644
--- a/java/org/apache/tomcat/util/net/AbstractEndpoint.java
+++ b/java/org/apache/tomcat/util/net/AbstractEndpoint.java
@@ -381,8 +381,8 @@ public abstract class AbstractEndpoint {
  *
  * @param sslHostConfig The SSLHostConfig for which the SSLContext should 
be
  *  created
- * @throws Exception If the SSLContext cannot be created for the given
- *   SSLHostConfig
+ * @throws IllegalArgumentException If the SSLContext cannot be created for
+ *  the given SSLHostConfig
  */
 protected void createSSLContext(SSLHostConfig sslHostConfig) throws 
IllegalArgumentException {
 


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc typo

2022-09-27 Thread lihan
This is an automated email from the ASF dual-hosted git repository.

lihan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new c386d43bdc Fix Javadoc typo
c386d43bdc is described below

commit c386d43bdcaa6764b3d639adcd1925ab56d8ce96
Author: lihan 
AuthorDate: Wed Sep 28 11:26:21 2022 +0800

Fix Javadoc typo
---
 java/org/apache/tomcat/util/net/AbstractEndpoint.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/tomcat/util/net/AbstractEndpoint.java 
b/java/org/apache/tomcat/util/net/AbstractEndpoint.java
index 05fe1fa834..2ce72e8acb 100644
--- a/java/org/apache/tomcat/util/net/AbstractEndpoint.java
+++ b/java/org/apache/tomcat/util/net/AbstractEndpoint.java
@@ -347,7 +347,7 @@ public abstract class AbstractEndpoint {
 }
 
 /**
- * Create the SSLContextfor the the given SSLHostConfig.
+ * Create the SSLContext for the given SSLHostConfig.
  *
  * @param sslHostConfig The SSLHostConfig for which the SSLContext should 
be
  *  created


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc typo

2022-08-25 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new d243251948 Fix Javadoc typo
d243251948 is described below

commit d243251948a351224f2e6d9d04264769cac27fbe
Author: Mark Thomas 
AuthorDate: Thu Aug 25 17:26:53 2022 +0100

Fix Javadoc typo
---
 java/org/apache/coyote/http11/AbstractHttp11Protocol.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/coyote/http11/AbstractHttp11Protocol.java 
b/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
index 1a88c314a0..c33ab7035a 100644
--- a/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
+++ b/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
@@ -227,7 +227,7 @@ public abstract class AbstractHttp11Protocol extends 
AbstractProtocol {
  * CLIENT-CERT authentication. When a POST is received where the security
  * constraints require a client certificate, the POST body needs to be
  * buffered while an SSL handshake takes place to obtain the certificate. A
- * similar buffering is required during FDORM auth.
+ * similar buffering is required during FORM auth.
  *
  * @param maxSavePostSize The maximum size POST body to buffer in bytes
  */


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc

2022-06-20 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new bce9b8c097 Fix Javadoc
bce9b8c097 is described below

commit bce9b8c097a837b11689a61923a6ba4a10c0ea47
Author: Mark Thomas 
AuthorDate: Mon Jun 20 15:03:27 2022 +0100

Fix Javadoc
---
 java/org/apache/tomcat/util/http/fileupload/disk/package-info.java | 3 +--
 java/org/apache/tomcat/util/http/fileupload/package-info.java  | 3 +--
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/java/org/apache/tomcat/util/http/fileupload/disk/package-info.java 
b/java/org/apache/tomcat/util/http/fileupload/disk/package-info.java
index 6e9599a82d..c82f4342d4 100644
--- a/java/org/apache/tomcat/util/http/fileupload/disk/package-info.java
+++ b/java/org/apache/tomcat/util/http/fileupload/disk/package-info.java
@@ -28,8 +28,7 @@
  *  {@link org.apache.tomcat.util.http.fileupload.disk.DiskFileItemFactory 
DiskFileItemFactory}
  *  would be created, configured, and then passed to a
  *  {@link org.apache.tomcat.util.http.fileupload.FileUpload FileUpload}
- *  implementation such as
- *  {@link 
org.apache.tomcat.util.http.fileupload.servlet.ServletFileUpload 
ServletFileUpload}.
+ *  implementation.
  *
  *
  *  The following code fragment demonstrates this usage.
diff --git a/java/org/apache/tomcat/util/http/fileupload/package-info.java 
b/java/org/apache/tomcat/util/http/fileupload/package-info.java
index f13b5983f5..dee2bb19fc 100644
--- a/java/org/apache/tomcat/util/http/fileupload/package-info.java
+++ b/java/org/apache/tomcat/util/http/fileupload/package-info.java
@@ -30,8 +30,7 @@
  * While this package provides the generic functionality for file uploads,
  * these classes are not typically used directly. Instead, normal usage
  * involves one of the provided extensions of
- * {@link org.apache.tomcat.util.http.fileupload.FileUpload FileUpload} such as
- * {@link org.apache.tomcat.util.http.fileupload.servlet.ServletFileUpload 
ServletFileUpload}
+ * {@link org.apache.tomcat.util.http.fileupload.FileUpload FileUpload}
  * together with a factory for
  * {@link org.apache.tomcat.util.http.fileupload.FileItem FileItem} instances,
  * such as


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc warnings that broke the build

2022-03-17 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new d92a812  Fix Javadoc warnings that broke the build
d92a812 is described below

commit d92a812492baa0e510cedf25ca10203303e7bf79
Author: Mark Thomas 
AuthorDate: Thu Mar 17 19:42:16 2022 +

Fix Javadoc warnings that broke the build
---
 java/org/apache/catalina/realm/DigestCredentialHandlerBase.java | 8 
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java 
b/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java
index 122adef..0291df0 100644
--- a/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java
+++ b/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java
@@ -297,8 +297,8 @@ public abstract class DigestCredentialHandlerBase 
implements CredentialHandler {
 /**
  * Implements String equality which always compares all characters in the
  * string, without stopping early if any characters do not match.
- *
- * @implNote
+ * 
+ * Note:
  * This implementation was adapted from {@link MessageDigest#isEqual}
  * which we assume is as optimizer-defeating as possible.
  *
@@ -347,8 +347,8 @@ public abstract class DigestCredentialHandlerBase 
implements CredentialHandler {
 /**
  * Implements byte-array equality which always compares all bytes in the
  * array, without stopping early if any bytes do not match.
- *
- * @implNote
+ * 
+ * Note:
  * Implementation note: this method delegates to {@link 
MessageDigest#isEqual}
  * under the assumption that it provides a constant-time comparison of the
  * bytes in the arrays. Java 7+ has such an implementation, but neither the

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc warnings for Servlet API when building with Java 16

2021-08-26 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new f969a8f1 Fix Javadoc warnings for Servlet API when building with Java 
16
f969a8f1 is described below

commit f969a8f19797e41a70956a66317bdaa72a398158
Author: Mark Thomas 
AuthorDate: Thu Aug 26 11:45:09 2021 +0100

Fix Javadoc warnings for Servlet API when building with Java 16
---
 java/jakarta/servlet/GenericFilter.java|  3 +
 java/jakarta/servlet/MultipartConfigElement.java   | 50 -
 java/jakarta/servlet/Registration.java | 11 +++
 java/jakarta/servlet/ServletContext.java   |  7 ++
 .../servlet/ServletContextAttributeEvent.java  |  7 ++
 java/jakarta/servlet/ServletRegistration.java  | 40 +++
 .../servlet/ServletRequestAttributeEvent.java  |  7 ++
 java/jakarta/servlet/ServletSecurityElement.java   | 16 -
 java/jakarta/servlet/SessionCookieConfig.java  | 37 +-
 java/jakarta/servlet/SessionTrackingMode.java  | 13 
 java/jakarta/servlet/UnavailableException.java | 17 -
 .../servlet/descriptor/JspConfigDescriptor.java| 21 +-
 .../descriptor/JspPropertyGroupDescriptor.java | 82 +-
 .../servlet/descriptor/TaglibDescriptor.java   | 15 +++-
 java/jakarta/servlet/http/Cookie.java  | 16 -
 java/jakarta/servlet/http/HttpServlet.java |  5 +-
 java/jakarta/servlet/http/HttpServletRequest.java  |  5 ++
 .../servlet/http/HttpSessionBindingEvent.java  |  8 ++-
 java/jakarta/servlet/http/MappingMatch.java| 22 ++
 19 files changed, 368 insertions(+), 14 deletions(-)

diff --git a/java/jakarta/servlet/GenericFilter.java 
b/java/jakarta/servlet/GenericFilter.java
index 210c225..3cdb815 100644
--- a/java/jakarta/servlet/GenericFilter.java
+++ b/java/jakarta/servlet/GenericFilter.java
@@ -30,6 +30,9 @@ public abstract class GenericFilter implements Filter, 
FilterConfig, Serializabl
 
 private static final long serialVersionUID = 1L;
 
+/**
+ * The filter configuration.
+ */
 private volatile FilterConfig filterConfig;
 
 
diff --git a/java/jakarta/servlet/MultipartConfigElement.java 
b/java/jakarta/servlet/MultipartConfigElement.java
index f30101c..dfae9d6 100644
--- a/java/jakarta/servlet/MultipartConfigElement.java
+++ b/java/jakarta/servlet/MultipartConfigElement.java
@@ -19,8 +19,11 @@ package jakarta.servlet;
 import jakarta.servlet.annotation.MultipartConfig;
 
 /**
+ * The programmatic equivalent of
+ * {@link jakarta.servlet.annotation.MultipartConfig} used to configure
+ * multi-part handling for a Servlet when registering a Servlet via code.
+ *
  * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
  */
 public class MultipartConfigElement {
 
@@ -29,6 +32,12 @@ public class MultipartConfigElement {
 private final long maxRequestSize;// = -1;
 private final int fileSizeThreshold;// = 0;
 
+/**
+ * Create a programmatic multi-part configuration with a specific location
+ * and defaults for the remaining configuration elements.
+ *
+ * @param location  The temporary location to store files
+ */
 public MultipartConfigElement(String location) {
 // Keep empty string default if location is null
 if (location != null) {
@@ -41,6 +50,17 @@ public class MultipartConfigElement {
 this.fileSizeThreshold = 0;
 }
 
+/**
+ * Create a programmatic multi-part configuration from the individual
+ * configuration elements.
+ *
+ * @param location  The temporary location to store files
+ * @param maxFileSize   The maximum permitted size for a single file
+ * @param maxRequestSizeThe maximum permitted size for a request
+ * @param fileSizeThreshold The size above which the file is save in the
+ *  temporary location rather than retained in
+ *  memory.
+ */
 public MultipartConfigElement(String location, long maxFileSize,
 long maxRequestSize, int fileSizeThreshold) {
 // Keep empty string default if location is null
@@ -60,6 +80,12 @@ public class MultipartConfigElement {
 }
 }
 
+/**
+ * Create a programmatic configuration from an annotation.
+ *
+ * @param annotation The source annotation to copy to create the
+ *   programmatic equivalent.
+ */
 public MultipartConfigElement(MultipartConfig annotation) {
 location = annotation.location();
 maxFileSize = annotation.maxFileSize();
@@ -67,18 +93,40 @@ public class MultipartConfigElement {
 fileSizeThreshold = annotation.fileSizeThreshold();
 }
 
+/**
+ * Obtain the location where temporary files should be stored.
+ *
+ * @return the locat

[tomcat] branch main updated: Fix Javadoc warning

2021-08-17 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 75ba84a  Fix Javadoc warning
75ba84a is described below

commit 75ba84a8e6f1abbeaf1bf242de8c53bdf4951862
Author: Mark Thomas 
AuthorDate: Tue Aug 17 15:54:42 2021 +0100

Fix Javadoc warning
---
 java/org/apache/catalina/users/GenericGroup.java | 2 ++
 java/org/apache/catalina/users/GenericRole.java  | 2 ++
 java/org/apache/catalina/users/GenericUser.java  | 2 ++
 3 files changed, 6 insertions(+)

diff --git a/java/org/apache/catalina/users/GenericGroup.java 
b/java/org/apache/catalina/users/GenericGroup.java
index d59e57d..986c9f7 100644
--- a/java/org/apache/catalina/users/GenericGroup.java
+++ b/java/org/apache/catalina/users/GenericGroup.java
@@ -31,6 +31,8 @@ import org.apache.catalina.UserDatabase;
  * Concrete implementation of {@link org.apache.catalina.Group} for a
  * {@link UserDatabase}.
  *
+ * @param  The specific type of UserDase with which this group is 
associated
+ *
  * @author Craig R. McClanahan
  */
 public class GenericGroup extends AbstractGroup {
diff --git a/java/org/apache/catalina/users/GenericRole.java 
b/java/org/apache/catalina/users/GenericRole.java
index c6b0eba..2957280 100644
--- a/java/org/apache/catalina/users/GenericRole.java
+++ b/java/org/apache/catalina/users/GenericRole.java
@@ -24,6 +24,8 @@ import org.apache.catalina.UserDatabase;
  * Concrete implementation of {@link org.apache.catalina.Role} for a
  * {@link UserDatabase}.
  *
+ * @param  The specific type of UserDase with which this role is associated
+ *
  * @author Craig R. McClanahan
  */
 public class GenericRole extends AbstractRole {
diff --git a/java/org/apache/catalina/users/GenericUser.java 
b/java/org/apache/catalina/users/GenericUser.java
index 77b70b4..7d69360 100644
--- a/java/org/apache/catalina/users/GenericUser.java
+++ b/java/org/apache/catalina/users/GenericUser.java
@@ -29,6 +29,8 @@ import org.apache.catalina.UserDatabase;
  * Concrete implementation of {@link org.apache.catalina.User} for a
  * {@link UserDatabase}.
  *
+ * @param  The specific type of UserDase with which this role is associated
+ *
  * @author Craig R. McClanahan
  */
 public class GenericUser extends AbstractUser {

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc warning

2021-08-17 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 263fb37  Fix Javadoc warning
263fb37 is described below

commit 263fb37b6507203aece9c8afb77272654cad80d1
Author: Mark Thomas 
AuthorDate: Tue Aug 17 15:49:33 2021 +0100

Fix Javadoc warning
---
 java/org/apache/catalina/authenticator/AuthenticatorBase.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/java/org/apache/catalina/authenticator/AuthenticatorBase.java 
b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
index 4a26b51..80aa13d 100644
--- a/java/org/apache/catalina/authenticator/AuthenticatorBase.java
+++ b/java/org/apache/catalina/authenticator/AuthenticatorBase.java
@@ -1372,7 +1372,7 @@ public abstract class AuthenticatorBase extends ValveBase
  * Can the authenticator perform preemptive authentication for the given
  * request?
  *
- * @param request
+ * @param request The request to check for credentials
  *
  * @return {@code true} if preemptive authentication is possible, otherwise
  * {@code false}

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc

2021-07-26 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new aa7ea3d  Fix Javadoc
aa7ea3d is described below

commit aa7ea3d4f4aa0bff8f059746b6a85bba5283dd72
Author: Mark Thomas 
AuthorDate: Mon Jul 26 17:59:54 2021 +0100

Fix Javadoc
---
 java/org/apache/catalina/filters/CorsFilter.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/java/org/apache/catalina/filters/CorsFilter.java 
b/java/org/apache/catalina/filters/CorsFilter.java
index c98de77..f64d7ad 100644
--- a/java/org/apache/catalina/filters/CorsFilter.java
+++ b/java/org/apache/catalina/filters/CorsFilter.java
@@ -74,13 +74,13 @@ import org.apache.tomcat.util.res.StringManager;
  * 'Access-Control-Request-Headers' header, for pre-flight request.
  * 
  *
- * @see http://www.w3.org/TR/cors/";>CORS specification
- *
  * If you extend this class and override one or more of the getXxx() methods,
  * consider whether you also need to override
  * {@link CorsFilter#doFilter(ServletRequest, ServletResponse, FilterChain)} 
and
  * add appropriate locking so that the {@code doFilter()} method executes with 
a
  * consistent configuration.
+ *
+ * @see http://www.w3.org/TR/cors/";>CORS specification
  */
 public class CorsFilter extends GenericFilter {
 

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch main updated: Fix Javadoc (and CI build)

2021-06-23 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 0ec9b4b  Fix Javadoc (and CI build)
0ec9b4b is described below

commit 0ec9b4b51325ff51bad5aaa375cec2af919711a9
Author: Mark Thomas 
AuthorDate: Wed Jun 23 15:51:59 2021 +0100

Fix Javadoc (and CI build)
---
 java/org/apache/catalina/realm/UserDatabaseRealm.java | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/java/org/apache/catalina/realm/UserDatabaseRealm.java 
b/java/org/apache/catalina/realm/UserDatabaseRealm.java
index c783ea5..c13b706 100644
--- a/java/org/apache/catalina/realm/UserDatabaseRealm.java
+++ b/java/org/apache/catalina/realm/UserDatabaseRealm.java
@@ -292,6 +292,8 @@ public class UserDatabaseRealm extends RealmBase {
 /**
  * Magic method from {@link java.io.Serializable}.
  *
+ * @return The object to serialize instead of this object
+ *
  * @throws ObjectStreamException Not thrown by this implementation
  */
 private Object writeReplace() throws ObjectStreamException {

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org