[tomcat] branch 10.0.x updated: Fix a Javadoc TODO

[ma...@apache.org]

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

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


The following commit(s) were added to refs/heads/10.0.x by this push:
     new f3ea67f  Fix a Javadoc TODO
f3ea67f is described below

commit f3ea67f50f8a262b5ea3408b30265175cc006944
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Nov 11 09:39:54 2021 +0000

    Fix a Javadoc TODO
    
    This needed doing but the primary purpose was to trigger a CI build
    (hence why I only fixed one TODO - I may need to trigger additional
    builds).
---
 java/jakarta/servlet/ServletContext.java | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/java/jakarta/servlet/ServletContext.java b/java/jakarta/servlet/ServletContext.java
index cd6385d..ce18fa6 100644
--- a/java/jakarta/servlet/ServletContext.java
+++ b/java/jakarta/servlet/ServletContext.java
@@ -768,10 +768,15 @@ public interface ServletContext {
             Class<? extends Filter> filterClass);
 
     /**
-     * TODO SERVLET3 - Add comments
-     * @param <T> TODO
-     * @param c   TODO
-     * @return TODO
+     * Create a Filter instance using the given class. The instance is just
+     * created. No initialisation occurs.
+     *
+     * @param <T> The type for the given class
+     * @param c   The the class for which an instance should be created
+     *
+     * @return The created Filter instance.
+     *
+     * @throws ServletException If the Filter instance cannot be created
      * @throws UnsupportedOperationException    If called from a
      *    {@link ServletContextListener#contextInitialized(ServletContextEvent)}
      *    method of a {@link ServletContextListener} that was not defined in a
@@ -779,7 +784,7 @@ public interface ServletContext {
      *    {@link jakarta.servlet.annotation.WebListener}. For example, a
      *    {@link ServletContextListener} defined in a TLD would not be able to
      *    use this method.
-     * @throws ServletException TODO
+     *
      * @since Servlet 3.0
      */
     public <T extends Filter> T createFilter(Class<T> c) throws ServletException;

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