[tomcat] 01/02: Complete some Javadoc TODOs

[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

commit 07740198c2d6eb6d8748729e7d7d236b57dca2a2
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Sat Nov 6 08:53:11 2021 +0000

    Complete some Javadoc TODOs
    
    While the Javadoc needed to be written, the primary motivation for this
    commit was triggering a CI build.
---
 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 a991e05..1730c79 100644
--- a/java/jakarta/servlet/ServletContext.java
+++ b/java/jakarta/servlet/ServletContext.java
@@ -644,11 +644,15 @@ public interface ServletContext {
     public ServletRegistration.Dynamic addJspFile(String jspName, String jspFile);
 
     /**
-     * TODO SERVLET3 - Add comments
-     * @param <T> TODO
-     * @param c   TODO
-     * @return TODO
-     * @throws ServletException TODO
+     * Create an Servlet 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 Servlet instance.
+     *
+     * @throws ServletException If the servlet 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
@@ -656,6 +660,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.
+     *
      * @since Servlet 3.0
      */
     public <T extends Servlet> T createServlet(Class<T> c)

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