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 a2dcf8edb2 CheckStyle Javadoc checks += JavadocMethod a2dcf8edb2 is described below commit a2dcf8edb2b591982d65a93284e44a68dbeb2475 Author: Mark Thomas <ma...@apache.org> AuthorDate: Thu Jan 12 16:10:41 2023 +0000 CheckStyle Javadoc checks += JavadocMethod --- java/org/apache/jasper/compiler/Node.java | 4 ++++ res/checkstyle/checkstyle.xml | 3 +++ .../classes/compressionFilters/CompressionResponseStream.java | 5 +++++ 3 files changed, 12 insertions(+) diff --git a/java/org/apache/jasper/compiler/Node.java b/java/org/apache/jasper/compiler/Node.java index ad4bf76ba9..95f43f5fe4 100644 --- a/java/org/apache/jasper/compiler/Node.java +++ b/java/org/apache/jasper/compiler/Node.java @@ -2331,6 +2331,8 @@ abstract class Node implements TagConstants { /** * This method provides a place to put actions that are common to all * nodes. Override this in the child visitor class if need to. + * + * @param n The node to visit */ @SuppressWarnings("unused") protected void doVisit(Node n) throws JasperException { @@ -2339,6 +2341,8 @@ abstract class Node implements TagConstants { /** * Visit the body of a node, using the current visitor + * + * @param n The node to visit */ protected void visitBody(Node n) throws JasperException { if (n.getBody() != null) { diff --git a/res/checkstyle/checkstyle.xml b/res/checkstyle/checkstyle.xml index 26e38c4141..3d285357fd 100644 --- a/res/checkstyle/checkstyle.xml +++ b/res/checkstyle/checkstyle.xml @@ -81,6 +81,9 @@ <module name="InvalidJavadocPosition"/> <module name="JavadocBlockTagLocation"/> <module name="JavadocContentLocationCheck"/> + <module name="JavadocMethod"> + <property name="accessModifiers" value="public,protected"/> + </module> <!-- Miscellaneous --> <!-- ~5500 errors diff --git a/webapps/examples/WEB-INF/classes/compressionFilters/CompressionResponseStream.java b/webapps/examples/WEB-INF/classes/compressionFilters/CompressionResponseStream.java index 451005f927..c6ee9e4e46 100644 --- a/webapps/examples/WEB-INF/classes/compressionFilters/CompressionResponseStream.java +++ b/webapps/examples/WEB-INF/classes/compressionFilters/CompressionResponseStream.java @@ -122,6 +122,9 @@ public class CompressionResponseStream extends ServletOutputStream { /** * Set the compressionThreshold number and create buffer for this size + * + * @param compressionThreshold Responses above this size in bytes will be + * compressed */ protected void setCompressionThreshold(int compressionThreshold) { this.compressionThreshold = compressionThreshold; @@ -133,6 +136,8 @@ public class CompressionResponseStream extends ServletOutputStream { /** * The compression buffer size to avoid chunking + * + * @param compressionBuffer The compression buffer size in bytes */ protected void setCompressionBuffer(int compressionBuffer) { this.compressionBuffer = compressionBuffer; --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org