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 2024/02/04 19:16:22 UTC
(tomcat) 01/05: Format clean-ups
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
commit b4bba6652e78be28f6c19409e511c4a6c50e173e
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Sun Feb 4 16:07:44 2024 +0000
Format clean-ups
---
java/org/apache/catalina/startup/ContextConfig.java | 8 +++++++-
java/org/apache/catalina/startup/ContextRuleSet.java | 4 ++--
java/org/apache/catalina/startup/CopyParentClassLoaderRule.java | 4 ++--
java/org/apache/catalina/startup/CredentialHandlerRuleSet.java | 4 ++--
java/org/apache/catalina/startup/EngineRuleSet.java | 4 ++--
java/org/apache/catalina/startup/HostRuleSet.java | 4 ++--
java/org/apache/catalina/startup/NamingRuleSet.java | 4 ++--
java/org/apache/catalina/startup/RealmRuleSet.java | 4 ++--
java/org/apache/catalina/startup/SetNextNamingRule.java | 9 ++++-----
java/org/apache/catalina/startup/Tool.java | 8 ++++----
10 files changed, 29 insertions(+), 24 deletions(-)
diff --git a/java/org/apache/catalina/startup/ContextConfig.java b/java/org/apache/catalina/startup/ContextConfig.java
index 6610105f4d..1e3edfe9e9 100644
--- a/java/org/apache/catalina/startup/ContextConfig.java
+++ b/java/org/apache/catalina/startup/ContextConfig.java
@@ -1022,9 +1022,11 @@ public class ContextConfig implements LifecycleListener {
protected void webConfig() {
/*
* Anything and everything can override the global and host defaults.
- * This is implemented in two parts
+ * This is implemented in two parts:
+ *
* - Handle as a web fragment that gets added after everything else so
* everything else takes priority
+ *
* - Mark Servlets as overridable so SCI configuration can replace
* configuration from the defaults
*/
@@ -1032,15 +1034,19 @@ public class ContextConfig implements LifecycleListener {
/*
* The rules for annotation scanning are not as clear-cut as one might
* think. Tomcat implements the following process:
+ *
* - As per SRV.1.6.2, Tomcat will scan for annotations regardless of
* which Servlet spec version is declared in web.xml. The EG has
* confirmed this is the expected behaviour.
+ *
* - As per http://java.net/jira/browse/SERVLET_SPEC-36, if the main
* web.xml is marked as metadata-complete, JARs are still processed
* for SCIs.
+ *
* - If metadata-complete=true and an absolute ordering is specified,
* JARs excluded from the ordering are also excluded from the SCI
* processing.
+ *
* - If an SCI has a @HandlesType annotation then all classes (except
* those in JARs excluded from an absolute ordering) need to be
* scanned to check if they match.
diff --git a/java/org/apache/catalina/startup/ContextRuleSet.java b/java/org/apache/catalina/startup/ContextRuleSet.java
index 4113826856..c9aa09f867 100644
--- a/java/org/apache/catalina/startup/ContextRuleSet.java
+++ b/java/org/apache/catalina/startup/ContextRuleSet.java
@@ -22,8 +22,8 @@ import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the contents of a
- * Context definition element.</p>
+ * <strong>RuleSet</strong> for processing the contents of a
+ * Context definition element.
*
* @author Craig R. McClanahan
*/
diff --git a/java/org/apache/catalina/startup/CopyParentClassLoaderRule.java b/java/org/apache/catalina/startup/CopyParentClassLoaderRule.java
index 1bc2fc5ab7..e1fb4fdc31 100644
--- a/java/org/apache/catalina/startup/CopyParentClassLoaderRule.java
+++ b/java/org/apache/catalina/startup/CopyParentClassLoaderRule.java
@@ -25,10 +25,10 @@ import org.xml.sax.Attributes;
/**
- * <p>Rule that copies the <code>parentClassLoader</code> property from the
+ * Rule that copies the <code>parentClassLoader</code> property from the
* next-to-top item on the stack (which must be a <code>Container</code>)
* to the top item on the stack (which must also be a
- * <code>Container</code>).</p>
+ * <code>Container</code>).
*
* @author Craig R. McClanahan
*/
diff --git a/java/org/apache/catalina/startup/CredentialHandlerRuleSet.java b/java/org/apache/catalina/startup/CredentialHandlerRuleSet.java
index 9e1298e487..8c08e2d1d4 100644
--- a/java/org/apache/catalina/startup/CredentialHandlerRuleSet.java
+++ b/java/org/apache/catalina/startup/CredentialHandlerRuleSet.java
@@ -20,10 +20,10 @@ import org.apache.tomcat.util.digester.Digester;
import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the contents of a
+ * <strong>RuleSet</strong> for processing the contents of a
* CredentialHandler definition element. This <code>RuleSet</code> supports
* CredentialHandler such as the <code>NestedCredentialHandler</code> that used
- * nested CredentialHandlers.</p>
+ * nested CredentialHandlers.
*/
@SuppressWarnings("deprecation")
public class CredentialHandlerRuleSet extends RuleSetBase {
diff --git a/java/org/apache/catalina/startup/EngineRuleSet.java b/java/org/apache/catalina/startup/EngineRuleSet.java
index a6beee992a..67d64a986c 100644
--- a/java/org/apache/catalina/startup/EngineRuleSet.java
+++ b/java/org/apache/catalina/startup/EngineRuleSet.java
@@ -22,10 +22,10 @@ import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the contents of a
+ * <strong>RuleSet</strong> for processing the contents of a
* Engine definition element. This <code>RuleSet</code> does NOT include
* any rules for nested Host elements, which should be added via instances of
- * <code>HostRuleSet</code>.</p>
+ * <code>HostRuleSet</code>.
*
* @author Craig R. McClanahan
*/
diff --git a/java/org/apache/catalina/startup/HostRuleSet.java b/java/org/apache/catalina/startup/HostRuleSet.java
index b9b5b69ba2..47073f2ce7 100644
--- a/java/org/apache/catalina/startup/HostRuleSet.java
+++ b/java/org/apache/catalina/startup/HostRuleSet.java
@@ -22,10 +22,10 @@ import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the contents of a
+ * <strong>RuleSet</strong> for processing the contents of a
* Host definition element. This <code>RuleSet</code> does NOT include
* any rules for nested Context which should be added via instances of
- * <code>ContextRuleSet</code>.</p>
+ * <code>ContextRuleSet</code>.
*
* @author Craig R. McClanahan
*/
diff --git a/java/org/apache/catalina/startup/NamingRuleSet.java b/java/org/apache/catalina/startup/NamingRuleSet.java
index 438b2eb9ad..bab8bcca8b 100644
--- a/java/org/apache/catalina/startup/NamingRuleSet.java
+++ b/java/org/apache/catalina/startup/NamingRuleSet.java
@@ -22,8 +22,8 @@ import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the JNDI Enterprise Naming
- * Context resource declaration elements.</p>
+ * <strong>RuleSet</strong> for processing the JNDI Enterprise Naming
+ * Context resource declaration elements.
*
* @author Craig R. McClanahan
* @author Remy Maucherat
diff --git a/java/org/apache/catalina/startup/RealmRuleSet.java b/java/org/apache/catalina/startup/RealmRuleSet.java
index c51423a198..0a5a241d04 100644
--- a/java/org/apache/catalina/startup/RealmRuleSet.java
+++ b/java/org/apache/catalina/startup/RealmRuleSet.java
@@ -22,9 +22,9 @@ import org.apache.tomcat.util.digester.RuleSetBase;
/**
- * <p><strong>RuleSet</strong> for processing the contents of a Realm definition
+ * <strong>RuleSet</strong> for processing the contents of a Realm definition
* element. This <code>RuleSet</code> supports Realms such as the
- * <code>CombinedRealm</code> that used nested Realms.</p>
+ * <code>CombinedRealm</code> that used nested Realms.
*/
@SuppressWarnings("deprecation")
public class RealmRuleSet extends RuleSetBase {
diff --git a/java/org/apache/catalina/startup/SetNextNamingRule.java b/java/org/apache/catalina/startup/SetNextNamingRule.java
index 6864051c12..b7a3db3339 100644
--- a/java/org/apache/catalina/startup/SetNextNamingRule.java
+++ b/java/org/apache/catalina/startup/SetNextNamingRule.java
@@ -23,14 +23,13 @@ import org.apache.tomcat.util.digester.Rule;
/**
- * <p>Rule implementation that calls a method on the (top-1) (parent)
+ * Rule implementation that calls a method on the (top-1) (parent)
* object, passing the top object (child) as an argument. It is
- * commonly used to establish parent-child relationships.</p>
- *
- * <p>This rule now supports more flexible method matching by default.
+ * commonly used to establish parent-child relationships.
+ * <p>
+ * This rule now supports more flexible method matching by default.
* It is possible that this may break (some) code
* written against release 1.1.1 or earlier.
- * </p>
*/
public class SetNextNamingRule extends Rule {
diff --git a/java/org/apache/catalina/startup/Tool.java b/java/org/apache/catalina/startup/Tool.java
index 911a1e06da..cb7927ca65 100644
--- a/java/org/apache/catalina/startup/Tool.java
+++ b/java/org/apache/catalina/startup/Tool.java
@@ -26,18 +26,18 @@ import org.apache.juli.logging.LogFactory;
/**
- * <p>General purpose wrapper for command line tools that should execute in an
+ * General purpose wrapper for command line tools that should execute in an
* environment with the common class loader environment set up by Catalina.
* This should be executed from a command line script that conforms to
- * the following requirements:</p>
+ * the following requirements:
* <ul>
* <li>Passes the <code>catalina.home</code> system property configured with
* the pathname of the Tomcat installation directory.</li>
* <li>Sets the system classpath to include <code>bootstrap.jar</code> and
* <code>$JAVA_HOME/lib/tools.jar</code>.</li>
* </ul>
- *
- * <p>The command line to execute the tool looks like:</p>
+ * <p>
+ * The command line to execute the tool looks like:
* <pre>
* java -classpath $CLASSPATH org.apache.catalina.startup.Tool \
* ${options} ${classname} ${arguments}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org