[tomcat] branch 8.5.x updated: Better Javadoc (prompted by reviewing a SpotBugs issue)

[ma...@apache.org]

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 211f48c  Better Javadoc (prompted by reviewing a SpotBugs issue)
211f48c is described below

commit 211f48c9ea75904ea48929f8e84345d757ce66e1
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Oct 16 11:46:52 2020 +0100

    Better Javadoc (prompted by reviewing a SpotBugs issue)
---
 java/org/apache/tomcat/util/http/parser/EntityTag.java | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/java/org/apache/tomcat/util/http/parser/EntityTag.java b/java/org/apache/tomcat/util/http/parser/EntityTag.java
index b2cfaba..f863ccc 100644
--- a/java/org/apache/tomcat/util/http/parser/EntityTag.java
+++ b/java/org/apache/tomcat/util/http/parser/EntityTag.java
@@ -30,7 +30,8 @@ public class EntityTag {
      * @param compareWeak  Use weak comparison e.g. match "etag" with W/"etag"
      * @param resourceETag Resource's ETag
      *
-     * @return true if ETag matched or {@code null} if the header is invalid
+     * @return {@code true} if ETag matches, {@code false} if ETag doesn't match
+     *         or {@code null} if the input is invalid
      *
      * @throws IOException If an I/O occurs during the parsing
      */


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