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 4bcef76a01 Expand CheckStyle checks for Javadoc 4bcef76a01 is described below commit 4bcef76a019a7d87505f081e213c447e0d2a8f8d Author: Mark Thomas <ma...@apache.org> AuthorDate: Thu Jan 12 13:55:42 2023 +0000 Expand CheckStyle checks for Javadoc --- java/org/apache/catalina/filters/CorsFilter.java | 4 ++-- java/org/apache/catalina/tribes/Channel.java | 2 +- java/org/apache/jasper/compiler/JspReader.java | 2 +- java/org/apache/jasper/compiler/Node.java | 8 ++++---- java/org/apache/jasper/compiler/Parser.java | 10 +++++----- java/org/apache/tomcat/util/buf/UriUtil.java | 4 ++-- java/org/apache/tomcat/util/modeler/Registry.java | 4 ++-- res/checkstyle/checkstyle.xml | 1 + webapps/docs/appdev/sample/src/mypackage/Hello.java | 2 +- webapps/examples/WEB-INF/classes/CookieExample.java | 2 +- webapps/examples/WEB-INF/classes/RequestHeaderExample.java | 2 +- webapps/examples/WEB-INF/classes/RequestInfoExample.java | 2 +- webapps/examples/WEB-INF/classes/RequestParamExample.java | 2 +- webapps/examples/WEB-INF/classes/SessionExample.java | 2 +- 14 files changed, 24 insertions(+), 23 deletions(-) diff --git a/java/org/apache/catalina/filters/CorsFilter.java b/java/org/apache/catalina/filters/CorsFilter.java index 618ffb0eeb..0b76b1e83d 100644 --- a/java/org/apache/catalina/filters/CorsFilter.java +++ b/java/org/apache/catalina/filters/CorsFilter.java @@ -763,11 +763,11 @@ public class CorsFilter extends GenericFilter { } /** - * Takes a comma separated list and returns a Set<String>. + * Takes a comma separated list and returns a Set<String>. * * @param data * A comma separated list of strings. - * @return Set<String> + * @return Set$lt;String> */ private Set<String> parseStringToSet(final String data) { String[] splits; diff --git a/java/org/apache/catalina/tribes/Channel.java b/java/org/apache/catalina/tribes/Channel.java index 16b426c611..f55b8dd06c 100644 --- a/java/org/apache/catalina/tribes/Channel.java +++ b/java/org/apache/catalina/tribes/Channel.java @@ -70,7 +70,7 @@ import org.apache.juli.logging.LogFactory; * MembershipService ChannelSender ChannelReceiver [IO layer] * </code></pre> * - * For example usage @see org.apache.catalina.tribes.group.GroupChannel + * @see org.apache.catalina.tribes.group.GroupChannel example usage */ public interface Channel { diff --git a/java/org/apache/jasper/compiler/JspReader.java b/java/org/apache/jasper/compiler/JspReader.java index c2c86cec6c..94ff0675af 100644 --- a/java/org/apache/jasper/compiler/JspReader.java +++ b/java/org/apache/jasper/compiler/JspReader.java @@ -487,7 +487,7 @@ class JspReader { * Skip until the given end tag is matched in the stream. * When returned, the context is positioned past the end of the tag. * - * @param tag The name of the tag whose ETag (</tag>) to match. + * @param tag The name of the tag whose ETag (</tag>) to match. * @return A non-null <code>Mark</code> instance (positioned immediately * before the ETag) if found, <strong>null</strong> otherwise. */ diff --git a/java/org/apache/jasper/compiler/Node.java b/java/org/apache/jasper/compiler/Node.java index b80221d4c4..03855c2939 100644 --- a/java/org/apache/jasper/compiler/Node.java +++ b/java/org/apache/jasper/compiler/Node.java @@ -757,7 +757,7 @@ abstract class Node implements TagConstants { } /** - * Represents a <jsp:invoke> tag file action + * Represents a <jsp:invoke> tag file action */ public static class InvokeAction extends Node { @@ -779,7 +779,7 @@ abstract class Node implements TagConstants { } /** - * Represents a <jsp:doBody> tag file action + * Represents a <jsp:doBody> tag file action */ public static class DoBodyAction extends Node { @@ -1181,7 +1181,7 @@ abstract class Node implements TagConstants { } /** - * Represents a <jsp:element>. + * Represents a <jsp:element>. */ public static class JspElement extends Node { @@ -1229,7 +1229,7 @@ abstract class Node implements TagConstants { } /** - * Represents a <jsp:output>. + * Represents a <jsp:output>. */ public static class JspOutput extends Node { diff --git a/java/org/apache/jasper/compiler/Parser.java b/java/org/apache/jasper/compiler/Parser.java index 3d4714daaa..444aa8736c 100644 --- a/java/org/apache/jasper/compiler/Parser.java +++ b/java/org/apache/jasper/compiler/Parser.java @@ -265,7 +265,7 @@ class Parser implements TagConstants { } /** - * AttributeValueDouble ::= (QuotedChar - '"')* ('"' | <TRANSLATION_ERROR>) + * AttributeValueDouble ::= (QuotedChar - '"')* ('"' | <TRANSLATION_ERROR>) * RTAttributeValueDouble ::= ((QuotedChar - '"')* - ((QuotedChar-'"')'%>"') * ('%>"' | TRANSLATION_ERROR) */ @@ -827,7 +827,7 @@ class Parser implements TagConstants { } /** - * Param ::= '<jsp:param' S Attributes S? EmptyBody S? + * Param ::= '<jsp:param' S Attributes S? EmptyBody S? */ private void parseParam(Node parent) throws JasperException { if (!reader.matches("<jsp:param")) { @@ -1016,8 +1016,8 @@ class Parser implements TagConstants { * Attempts to parse 'JspAttributeAndBody' production. Returns true if it * matched, or false if not. Assumes EmptyBody is okay as well. * - * JspAttributeAndBody ::= ( '>' # S? ( '<jsp:attribute' NamedAttributes )? '<jsp:body' ( - * JspBodyBody | <TRANSLATION_ERROR> ) S? ETag ) + * JspAttributeAndBody ::= ( '>' # S? ( '<jsp:attribute' NamedAttributes )? '<jsp:body' ( + * JspBodyBody | <TRANSLATION_ERROR> ) S? ETag ) */ private boolean parseJspAttributeAndBody(Node parent, String tag, String bodyType) throws JasperException { @@ -1659,7 +1659,7 @@ class Parser implements TagConstants { } /** - * Determine the body type of <jsp:attribute> from the enclosing node + * Determine the body type of <jsp:attribute> from the enclosing node */ private String getAttributeBodyType(Node n, String name) { diff --git a/java/org/apache/tomcat/util/buf/UriUtil.java b/java/org/apache/tomcat/util/buf/UriUtil.java index 12a1280ace..3665fdcd02 100644 --- a/java/org/apache/tomcat/util/buf/UriUtil.java +++ b/java/org/apache/tomcat/util/buf/UriUtil.java @@ -76,8 +76,8 @@ public final class UriUtil { * * @param c The character to test * - * @return {@code true} if a the character is allowed, otherwise {code - * @false} + * @return {@code true} if a the character is allowed, otherwise {@code + * false} */ private static boolean isSchemeChar(char c) { return Character.isLetterOrDigit(c) || c == '+' || c == '-' || c == '.'; diff --git a/java/org/apache/tomcat/util/modeler/Registry.java b/java/org/apache/tomcat/util/modeler/Registry.java index 72f877988c..2d981b41db 100644 --- a/java/org/apache/tomcat/util/modeler/Registry.java +++ b/java/org/apache/tomcat/util/modeler/Registry.java @@ -60,8 +60,8 @@ import org.apache.tomcat.util.res.StringManager; * * This class is itself an mbean. * - * IMPORTANT: public methods not marked with @since x.x are experimental or - * internal. Should not be used. + * IMPORTANT: public methods not marked with {@code @since x.x} are experimental + * or internal. Should not be used. * * @author Craig R. McClanahan * @author Costin Manolache diff --git a/res/checkstyle/checkstyle.xml b/res/checkstyle/checkstyle.xml index dffad923a9..f3583386bd 100644 --- a/res/checkstyle/checkstyle.xml +++ b/res/checkstyle/checkstyle.xml @@ -79,6 +79,7 @@ <!-- Javadoc Comments --> <module name="InvalidJavadocPosition"/> + <module name="JavadocBlockTagLocation"/> <!-- Miscellaneous --> <!-- ~5500 errors diff --git a/webapps/docs/appdev/sample/src/mypackage/Hello.java b/webapps/docs/appdev/sample/src/mypackage/Hello.java index 79c1f87156..de70781b8f 100644 --- a/webapps/docs/appdev/sample/src/mypackage/Hello.java +++ b/webapps/docs/appdev/sample/src/mypackage/Hello.java @@ -31,7 +31,7 @@ import jakarta.servlet.http.HttpServletResponse; * this servlet must be mapped to correspond to the link in the * "index.html" file. * - * @author Craig R. McClanahan <craig.mcclana...@eng.sun.com> + * @author Craig R. McClanahan <craig.mcclana...@eng.sun.com> */ public final class Hello extends HttpServlet { diff --git a/webapps/examples/WEB-INF/classes/CookieExample.java b/webapps/examples/WEB-INF/classes/CookieExample.java index f908d01836..2ed975df3e 100644 --- a/webapps/examples/WEB-INF/classes/CookieExample.java +++ b/webapps/examples/WEB-INF/classes/CookieExample.java @@ -32,7 +32,7 @@ import util.HTMLFilter; /** * Example servlet showing request headers * - * @author James Duncan Davidson <dun...@eng.sun.com> + * @author James Duncan Davidson <dun...@eng.sun.com> */ public class CookieExample extends HttpServlet { diff --git a/webapps/examples/WEB-INF/classes/RequestHeaderExample.java b/webapps/examples/WEB-INF/classes/RequestHeaderExample.java index 1bbd0889d1..180525dd14 100644 --- a/webapps/examples/WEB-INF/classes/RequestHeaderExample.java +++ b/webapps/examples/WEB-INF/classes/RequestHeaderExample.java @@ -33,7 +33,7 @@ import util.HTMLFilter; /** * Example servlet showing request headers * - * @author James Duncan Davidson <dun...@eng.sun.com> + * @author James Duncan Davidson <dun...@eng.sun.com> */ public class RequestHeaderExample extends HttpServlet { diff --git a/webapps/examples/WEB-INF/classes/RequestInfoExample.java b/webapps/examples/WEB-INF/classes/RequestInfoExample.java index a1d64e869d..7b5e18a6b3 100644 --- a/webapps/examples/WEB-INF/classes/RequestInfoExample.java +++ b/webapps/examples/WEB-INF/classes/RequestInfoExample.java @@ -29,7 +29,7 @@ import util.HTMLFilter; /** * Example servlet showing request information. * - * @author James Duncan Davidson <dun...@eng.sun.com> + * @author James Duncan Davidson <dun...@eng.sun.com> */ public class RequestInfoExample extends HttpServlet { diff --git a/webapps/examples/WEB-INF/classes/RequestParamExample.java b/webapps/examples/WEB-INF/classes/RequestParamExample.java index c326cb653e..4c4e668e5a 100644 --- a/webapps/examples/WEB-INF/classes/RequestParamExample.java +++ b/webapps/examples/WEB-INF/classes/RequestParamExample.java @@ -29,7 +29,7 @@ import util.HTMLFilter; /** * Example servlet showing request headers * - * @author James Duncan Davidson <dun...@eng.sun.com> + * @author James Duncan Davidson <dun...@eng.sun.com> */ public class RequestParamExample extends HttpServlet { diff --git a/webapps/examples/WEB-INF/classes/SessionExample.java b/webapps/examples/WEB-INF/classes/SessionExample.java index dbc46cd0ff..b7210fdfd9 100644 --- a/webapps/examples/WEB-INF/classes/SessionExample.java +++ b/webapps/examples/WEB-INF/classes/SessionExample.java @@ -32,7 +32,7 @@ import util.HTMLFilter; /** * Example servlet showing request headers * - * @author James Duncan Davidson <dun...@eng.sun.com> + * @author James Duncan Davidson <dun...@eng.sun.com> */ public class SessionExample extends HttpServlet { --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org