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/13 10:52:21 UTC

[tomcat] branch main updated: Checkstyle checks for Javadoc += SingleLineJavadoc

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 466326b671 Checkstyle checks for Javadoc += SingleLineJavadoc
466326b671 is described below

commit 466326b67135741ae43cd121cf77b877982a4427
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Jan 13 10:37:21 2023 +0000

    Checkstyle checks for Javadoc += SingleLineJavadoc
---
 .../tomcat/dbcp/dbcp2/DelegatingCallableStatement.java   |  4 +++-
 .../tomcat/dbcp/dbcp2/DelegatingPreparedStatement.java   |  4 +++-
 .../apache/tomcat/dbcp/dbcp2/DelegatingResultSet.java    | 16 ++++++++++++----
 res/checkstyle/checkstyle.xml                            |  4 ++++
 4 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingCallableStatement.java b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingCallableStatement.java
index d8fce5b93c..1f365e2292 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingCallableStatement.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingCallableStatement.java
@@ -97,7 +97,9 @@ public class DelegatingCallableStatement extends DelegatingPreparedStatement imp
         }
     }
 
-    /** @deprecated Use {@link #getBigDecimal(int)} or {@link #getBigDecimal(String)} */
+    /**
+     * @deprecated Use {@link #getBigDecimal(int)} or {@link #getBigDecimal(String)}
+     */
     @Override
     @Deprecated
     public BigDecimal getBigDecimal(final int parameterIndex, final int scale) throws SQLException {
diff --git a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingPreparedStatement.java b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingPreparedStatement.java
index 4ecf26f891..0dd7668a95 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingPreparedStatement.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingPreparedStatement.java
@@ -660,7 +660,9 @@ public class DelegatingPreparedStatement extends DelegatingStatement implements
         }
     }
 
-    /** @deprecated Use setAsciiStream(), setCharacterStream() or setNCharacterStream() */
+    /**
+     * @deprecated Use setAsciiStream(), setCharacterStream() or setNCharacterStream()
+     */
     @Deprecated
     @Override
     public void setUnicodeStream(final int parameterIndex, final InputStream x, final int length) throws SQLException {
diff --git a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingResultSet.java b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingResultSet.java
index 62b1a3b612..227d806833 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DelegatingResultSet.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DelegatingResultSet.java
@@ -277,7 +277,9 @@ public final class DelegatingResultSet extends AbandonedTrace implements ResultS
         }
     }
 
-    /** @deprecated Use {@link #getBigDecimal(int)} */
+    /**
+     * @deprecated Use {@link #getBigDecimal(int)}
+     */
     @Deprecated
     @Override
     public BigDecimal getBigDecimal(final int columnIndex, final int scale) throws SQLException {
@@ -299,7 +301,9 @@ public final class DelegatingResultSet extends AbandonedTrace implements ResultS
         }
     }
 
-    /** @deprecated Use {@link #getBigDecimal(String)} */
+    /**
+     * @deprecated Use {@link #getBigDecimal(String)}
+     */
     @Deprecated
     @Override
     public BigDecimal getBigDecimal(final String columnName, final int scale) throws SQLException {
@@ -990,7 +994,9 @@ public final class DelegatingResultSet extends AbandonedTrace implements ResultS
         }
     }
 
-    /** @deprecated Use {@link #getCharacterStream(int)} */
+    /**
+     * @deprecated Use {@link #getCharacterStream(int)}
+     */
     @Deprecated
     @Override
     public InputStream getUnicodeStream(final int columnIndex) throws SQLException {
@@ -1002,7 +1008,9 @@ public final class DelegatingResultSet extends AbandonedTrace implements ResultS
         }
     }
 
-    /** @deprecated Use {@link #getCharacterStream(String)} */
+    /**
+     * @deprecated Use {@link #getCharacterStream(String)}
+     */
     @Deprecated
     @Override
     public InputStream getUnicodeStream(final String columnName) throws SQLException {
diff --git a/res/checkstyle/checkstyle.xml b/res/checkstyle/checkstyle.xml
index 31a8a31a69..8eae3cd4ce 100644
--- a/res/checkstyle/checkstyle.xml
+++ b/res/checkstyle/checkstyle.xml
@@ -101,6 +101,10 @@
     <module name="MissingJavadocType"/>
     -->
     <module name="NonEmptyAtclauseDescription"/>
+    <!-- ~1600 errors
+    <module name="RequireEmptyLineBeforeBlockTagGroup"/>
+    -->
+    <module name="SingleLineJavadoc"/>
 
     <!-- Miscellaneous -->
     <!-- ~5500 errors


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