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 9c9afff9fb CheckStyle Javadoc checks += JavadocMissingLeadingAsterisk 9c9afff9fb is described below commit 9c9afff9fbe600fcb14e62e30e59f4a95770bdc7 Author: Mark Thomas <ma...@apache.org> AuthorDate: Thu Jan 12 18:41:58 2023 +0000 CheckStyle Javadoc checks += JavadocMissingLeadingAsterisk --- java/javax/servlet/jsp/tagext/TagData.java | 2 +- java/org/apache/catalina/realm/JAASRealm.java | 26 ++++++++++++---------- java/org/apache/catalina/servlets/CGIServlet.java | 2 +- .../TomcatURLStreamHandlerFactory.java | 1 - java/org/apache/coyote/ajp/AjpProcessor.java | 2 +- java/org/apache/naming/StringManager.java | 14 ++++++------ .../apache/tomcat/jdbc/pool/PoolConfiguration.java | 10 ++++----- res/checkstyle/checkstyle.xml | 1 + 8 files changed, 30 insertions(+), 28 deletions(-) diff --git a/java/javax/servlet/jsp/tagext/TagData.java b/java/javax/servlet/jsp/tagext/TagData.java index 78f3e17988..9740164b35 100644 --- a/java/javax/servlet/jsp/tagext/TagData.java +++ b/java/javax/servlet/jsp/tagext/TagData.java @@ -50,7 +50,7 @@ public class TagData implements Cloneable { * * All values must be Strings except for those holding the * distinguished object REQUEST_TIME_VALUE. - + * * @param atts the static attribute and values. May be null. */ public TagData(Object[] atts[]) { diff --git a/java/org/apache/catalina/realm/JAASRealm.java b/java/org/apache/catalina/realm/JAASRealm.java index ce3c4bafdd..71c2af984c 100644 --- a/java/org/apache/catalina/realm/JAASRealm.java +++ b/java/org/apache/catalina/realm/JAASRealm.java @@ -96,21 +96,23 @@ import org.apache.tomcat.util.ExceptionUtils; * with this name in the JAAS configuration file. Here is a hypothetical * JAAS configuration file entry for a database-oriented login module that uses * a Tomcat-managed JNDI database resource: - * <blockquote><pre>Catalina { -org.foobar.auth.DatabaseLoginModule REQUIRED - JNDI_RESOURCE=jdbc/AuthDB - USER_TABLE=users - USER_ID_COLUMN=id - USER_NAME_COLUMN=name - USER_CREDENTIAL_COLUMN=password - ROLE_TABLE=roles - ROLE_NAME_COLUMN=name - PRINCIPAL_FACTORY=org.foobar.auth.impl.SimplePrincipalFactory; -};</pre></blockquote></li> + * <blockquote><pre> + * Catalina { + * org.foobar.auth.DatabaseLoginModule REQUIRED + * JNDI_RESOURCE=jdbc/AuthDB + * USER_TABLE=users + * USER_ID_COLUMN=id + * USER_NAME_COLUMN=name + * USER_CREDENTIAL_COLUMN=password + * ROLE_TABLE=roles + * ROLE_NAME_COLUMN=name + * PRINCIPAL_FACTORY=org.foobar.auth.impl.SimplePrincipalFactory; + * }; + * </pre></blockquote></li> * <li>To set the JAAS configuration file * location, set the <code>CATALINA_OPTS</code> environment variable * similar to the following: -<blockquote><code>CATALINA_OPTS="-Djava.security.auth.login.config=$CATALINA_HOME/conf/jaas.config"</code></blockquote> + * <blockquote><code>CATALINA_OPTS="-Djava.security.auth.login.config=$CATALINA_HOME/conf/jaas.config"</code></blockquote> * </li> * <li>As part of the login process, JAASRealm registers its own <code>CallbackHandler</code>, * called (unsurprisingly) <code>JAASCallbackHandler</code>. This handler supplies the diff --git a/java/org/apache/catalina/servlets/CGIServlet.java b/java/org/apache/catalina/servlets/CGIServlet.java index 902f138a59..1b6e5cb9da 100644 --- a/java/org/apache/catalina/servlets/CGIServlet.java +++ b/java/org/apache/catalina/servlets/CGIServlet.java @@ -764,7 +764,7 @@ public final class CGIServlet extends HttpServlet { * * @return true if the request was parsed without error, false if there * was a problem - + * * @throws UnsupportedEncodingException Unknown encoding */ protected boolean setupFromRequest(HttpServletRequest req) diff --git a/java/org/apache/catalina/webresources/TomcatURLStreamHandlerFactory.java b/java/org/apache/catalina/webresources/TomcatURLStreamHandlerFactory.java index f2dd35ba39..d58f9d3fef 100644 --- a/java/org/apache/catalina/webresources/TomcatURLStreamHandlerFactory.java +++ b/java/org/apache/catalina/webresources/TomcatURLStreamHandlerFactory.java @@ -86,7 +86,6 @@ public class TomcatURLStreamHandlerFactory implements URLStreamHandlerFactory { * successfully disabled as a result of this call. * <code>false</code> if the factory was already registered prior * to this call. - */ public static boolean disable() { return !getInstanceInternal(false).isRegistered(); diff --git a/java/org/apache/coyote/ajp/AjpProcessor.java b/java/org/apache/coyote/ajp/AjpProcessor.java index 322a14ecd3..27f9eff1ad 100644 --- a/java/org/apache/coyote/ajp/AjpProcessor.java +++ b/java/org/apache/coyote/ajp/AjpProcessor.java @@ -652,7 +652,7 @@ public class AjpProcessor extends AbstractProcessor { * @param message The message to populate * @param block If there is no data available to read when this method is * called, should this call block until data becomes available? - + * * @return true if the message has been read, false if no data was read * * @throws IOException any other failure, including incomplete reads diff --git a/java/org/apache/naming/StringManager.java b/java/org/apache/naming/StringManager.java index b20094d071..c34368acd1 100644 --- a/java/org/apache/naming/StringManager.java +++ b/java/org/apache/naming/StringManager.java @@ -92,13 +92,13 @@ public class StringManager { } /** - Get a string from the underlying resource bundle or return - null if the String is not found. - - @param key to desired resource String - @return resource String matching <i>key</i> from underlying - bundle or null if not found. - @throws IllegalArgumentException if <i>key</i> is null. + * Get a string from the underlying resource bundle or return + * null if the String is not found. + * + * @param key to desired resource String + * @return resource String matching <i>key</i> from underlying + * bundle or null if not found. + * @throws IllegalArgumentException if <i>key</i> is null. */ public String getString(String key) { if(key == null){ diff --git a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java index fa78f9db41..6fbf62f7fb 100644 --- a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java +++ b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/PoolConfiguration.java @@ -669,11 +669,11 @@ public interface PoolConfiguration { * Returns true if the pool sweeper is enabled for the connection pool. * The pool sweeper is enabled if any settings that require async intervention in the pool are turned on * <code> - boolean result = getTimeBetweenEvictionRunsMillis()>0; - result = result && (isRemoveAbandoned() && getRemoveAbandonedTimeout()>0); - result = result || (isTestWhileIdle() && getValidationQuery()!=null); - return result; - </code> + * boolean result = getTimeBetweenEvictionRunsMillis()>0; + * result = result && (isRemoveAbandoned() && getRemoveAbandonedTimeout()>0); + * result = result || (isTestWhileIdle() && getValidationQuery()!=null); + * return result; + * </code> * * @return true if a background thread is or will be enabled for this pool */ diff --git a/res/checkstyle/checkstyle.xml b/res/checkstyle/checkstyle.xml index e39f19f70e..e453bbb3fb 100644 --- a/res/checkstyle/checkstyle.xml +++ b/res/checkstyle/checkstyle.xml @@ -84,6 +84,7 @@ <module name="JavadocMethod"> <property name="accessModifiers" value="public,protected"/> </module> + <module name="JavadocMissingLeadingAsterisk"/> <!-- Miscellaneous --> <!-- ~5500 errors --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org