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 9f882b290e Expand CheckStyle checks for Javadoc 9f882b290e is described below commit 9f882b290e391b5dee688c61e313a1eb94e38a7f 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/catalina/util/ExtensionValidator.java | 2 +- java/org/apache/jasper/EmbeddedServletOptions.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 +- 16 files changed, 26 insertions(+), 25 deletions(-) diff --git a/java/org/apache/catalina/filters/CorsFilter.java b/java/org/apache/catalina/filters/CorsFilter.java index 2ce4e04744..0145e50ff3 100644 --- a/java/org/apache/catalina/filters/CorsFilter.java +++ b/java/org/apache/catalina/filters/CorsFilter.java @@ -780,11 +780,11 @@ public class CorsFilter implements Filter { } /** - * 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 14db643a32..2fd8cd667a 100644 --- a/java/org/apache/catalina/tribes/Channel.java +++ b/java/org/apache/catalina/tribes/Channel.java @@ -66,7 +66,7 @@ import org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor; * 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/catalina/util/ExtensionValidator.java b/java/org/apache/catalina/util/ExtensionValidator.java index 759cf6d9c8..7501aa8171 100644 --- a/java/org/apache/catalina/util/ExtensionValidator.java +++ b/java/org/apache/catalina/util/ExtensionValidator.java @@ -189,7 +189,7 @@ public final class ExtensionValidator { * objects. This method requires an application name (which is the * context root of the application at runtime). * - * <code>false</false> is returned if the extension dependencies + * <code>false</code> is returned if the extension dependencies * represented by any given <code>ManifestResource</code> objects * is not met. * diff --git a/java/org/apache/jasper/EmbeddedServletOptions.java b/java/org/apache/jasper/EmbeddedServletOptions.java index 7113115140..5a8664c32f 100644 --- a/java/org/apache/jasper/EmbeddedServletOptions.java +++ b/java/org/apache/jasper/EmbeddedServletOptions.java @@ -114,7 +114,7 @@ public final class EmbeddedServletOptions implements Options { /** * Need to have this as is for versions 4 and 5 of IE. Can be set from * the initParams so if it changes in the future all that is needed is - * to have a jsp initParam of type ieClassId="<value>" + * to have a jsp initParam of type ieClassId="<value>" */ private String ieClassId = "clsid:8AD9C840-044E-11D1-B3E9-00805F499D93"; 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 5677ef49de..13a2e511a7 100644 --- a/java/org/apache/jasper/compiler/Node.java +++ b/java/org/apache/jasper/compiler/Node.java @@ -755,7 +755,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 { @@ -777,7 +777,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 { @@ -1263,7 +1263,7 @@ abstract class Node implements TagConstants { } /** - * Represents a <jsp:element>. + * Represents a <jsp:element>. */ public static class JspElement extends Node { @@ -1311,7 +1311,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 10b2442641..a9298d8e06 100644 --- a/java/org/apache/jasper/compiler/Parser.java +++ b/java/org/apache/jasper/compiler/Parser.java @@ -274,7 +274,7 @@ class Parser implements TagConstants { } /** - * AttributeValueDouble ::= (QuotedChar - '"')* ('"' | <TRANSLATION_ERROR>) + * AttributeValueDouble ::= (QuotedChar - '"')* ('"' | <TRANSLATION_ERROR>) * RTAttributeValueDouble ::= ((QuotedChar - '"')* - ((QuotedChar-'"')'%>"') * ('%>"' | TRANSLATION_ERROR) */ @@ -836,7 +836,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")) { @@ -1025,8 +1025,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 { @@ -1740,7 +1740,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 22dfb2dc98..63c933ac0f 100644 --- a/java/org/apache/tomcat/util/buf/UriUtil.java +++ b/java/org/apache/tomcat/util/buf/UriUtil.java @@ -75,8 +75,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 734aee1670..b8b606645f 100644 --- a/java/org/apache/tomcat/util/modeler/Registry.java +++ b/java/org/apache/tomcat/util/modeler/Registry.java @@ -59,8 +59,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 960a6104f0..6e42f1771e 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 6984ffe4ef..190e01ca8f 100644 --- a/webapps/docs/appdev/sample/src/mypackage/Hello.java +++ b/webapps/docs/appdev/sample/src/mypackage/Hello.java @@ -31,7 +31,7 @@ import javax.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 d8b65c8380..cbf375e861 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 2520904c85..a80076c697 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 0d6cc711e1..72627aa4cf 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 e1307a522e..5a991c36e8 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 4515fc330f..78c33c9cc6 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