You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2023/01/12 16:11:59 UTC
[tomcat] branch 10.1.x updated: CheckStyle Javadoc checks += JavadocMethod
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 10.1.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/10.1.x by this push:
new eca5f57c98 CheckStyle Javadoc checks += JavadocMethod
eca5f57c98 is described below
commit eca5f57c98d58d7778d88e1aec9897a3f3d35db3
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 8f7114b11c..3f7a2f18d2 100644
--- a/java/org/apache/jasper/compiler/Node.java
+++ b/java/org/apache/jasper/compiler/Node.java
@@ -2415,6 +2415,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 {
@@ -2423,6 +2425,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-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org