[tomcat] 13/13: Fix Javadoc warnings

[ma...@apache.org]

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

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

commit e9c8684be4029ec4afffa26dcc2060cc32b09efe
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Sep 27 17:29:57 2019 +0100

    Fix Javadoc warnings
---
 java/org/apache/catalina/connector/Request.java | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/java/org/apache/catalina/connector/Request.java b/java/org/apache/catalina/connector/Request.java
index 33ddb97..f916ad7 100644
--- a/java/org/apache/catalina/connector/Request.java
+++ b/java/org/apache/catalina/connector/Request.java
@@ -607,6 +607,12 @@ public class Request implements HttpServletRequest {
 
     /**
      * Return the Context within which this Request is being processed.
+     * <p>
+     * This is available as soon as the appropriate Context is identified.
+     * Note that availability of a Context allows <code>getContextPath()</code>
+     * to return a value, and thus enables parsing of the request URI.
+     *
+     * @return the Context mapped with the request
      */
     public Context getContext() {
         return this.context;
@@ -678,7 +684,7 @@ public class Request implements HttpServletRequest {
             "org.apache.coyote.catalina.CoyoteRequest/1.0";
 
     /**
-     * Return descriptive information about this Request implementation and
+     * @return descriptive information about this Request implementation and
      * the corresponding version number, in the format
      * <code>&lt;description&gt;/&lt;version&gt;</code>.
      */
@@ -842,7 +848,7 @@ public class Request implements HttpServletRequest {
 
 
     /**
-     * Return an Iterator containing the String names of all notes bindings
+     * @return an Iterator containing the String names of all notes bindings
      * that exist for this request.
      */
     @Deprecated
@@ -2213,6 +2219,8 @@ public class Request implements HttpServletRequest {
 
     /**
      * Set the set of cookies received with this Request.
+     *
+     * @param cookies The array of recewived cookies
      */
     @Deprecated
     public void setCookies(Cookie[] cookies) {
@@ -2718,7 +2726,7 @@ public class Request implements HttpServletRequest {
 
 
     /**
-     * Return true if the current request is handling Comet traffic.
+     * @return true if the current request is handling Comet traffic.
      */
     public boolean isComet() {
         return comet;
@@ -2727,6 +2735,9 @@ public class Request implements HttpServletRequest {
 
     /**
      * Set comet state.
+     *
+     * @param comet New value for flag that indicates whether this request is
+     *              handling Comet traffic
      */
     public void setComet(boolean comet) {
         this.comet = comet;
@@ -3027,6 +3038,10 @@ public class Request implements HttpServletRequest {
     // --------------------------------- Tomcat proprietary HTTP upgrade methods
 
     /**
+     * @param inbound The inbound connection to be upgraded
+     *
+     * @throws IOException if an I/O error occurrs during the upgrade process
+     *
      * @deprecated  Will be removed in Tomcat 8.0.x.
      */
     @Deprecated


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