This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-logging.git
The following commit(s) were added to refs/heads/master by this push:
new 0a1c5b9 Javadoc
0a1c5b9 is described below
commit 0a1c5b9b7b29a3686d4fc21481998a2baa919ee5
Author: Gary Gregory <[email protected]>
AuthorDate: Thu Apr 30 14:23:18 2026 -0400
Javadoc
Close HTML tags
---
src/main/java/org/apache/commons/logging/Log.java | 8 +++++++-
src/main/java/org/apache/commons/logging/LogSource.java | 4 +++-
src/main/java/org/apache/commons/logging/impl/AvalonLogger.java | 2 ++
src/main/java/org/apache/commons/logging/impl/Log4JLogger.java | 4 ++++
.../org/apache/commons/logging/impl/ServletContextCleaner.java | 2 ++
5 files changed, 18 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/logging/Log.java
b/src/main/java/org/apache/commons/logging/Log.java
index 3133c98..284b5fb 100644
--- a/src/main/java/org/apache/commons/logging/Log.java
+++ b/src/main/java/org/apache/commons/logging/Log.java
@@ -24,6 +24,7 @@ package org.apache.commons.logging;
* parameter representing the "name" of this Log.
* <p>
* The six logging levels used by {@code Log} are (in order):
+ * </p>
* <ol>
* <li>trace (the least serious)</li>
* <li>debug</li>
@@ -32,17 +33,21 @@ package org.apache.commons.logging;
* <li>error</li>
* <li>fatal (the most serious)</li>
* </ol>
+ * <p>
* The mapping of these log levels to the concepts used by the underlying
* logging system is implementation dependent.
* The implementation should ensure, though, that this ordering behaves
* as expected.
+ * </p>
* <p>
* Performance is often a logging concern.
* By examining the appropriate property,
* a component can avoid expensive operations (producing information
* to be logged).
+ * </p>
* <p>
- * For example,
+ * For example:
+ * </p>
* <pre>
* if (log.isDebugEnabled()) {
* ... do something expensive ...
@@ -53,6 +58,7 @@ package org.apache.commons.logging;
* Configuration of the underlying logging system will generally be done
* external to the Logging APIs, through whatever mechanism is supported by
* that system.
+ * </p>
*/
public interface Log {
diff --git a/src/main/java/org/apache/commons/logging/LogSource.java
b/src/main/java/org/apache/commons/logging/LogSource.java
index 9fec02b..0ccebef 100644
--- a/src/main/java/org/apache/commons/logging/LogSource.java
+++ b/src/main/java/org/apache/commons/logging/LogSource.java
@@ -29,6 +29,7 @@ import org.apache.commons.logging.impl.NoOpLog;
* <p>
* By default, calling {@code getInstance()} will use the following
* algorithm:
+ * </p>
* <ul>
* <li>If Log4J is available, return an instance of
* {@code org.apache.commons.logging.impl.Log4JLogger}.</li>
@@ -39,6 +40,7 @@ import org.apache.commons.logging.impl.NoOpLog;
* </ul>
* <p>
* You can change the default behavior in one of two ways:
+ * </p>
* <ul>
* <li>On the startup command line, set the system property
* {@code org.apache.commons.logging.log} to the name of the
@@ -47,7 +49,7 @@ import org.apache.commons.logging.impl.NoOpLog;
* <li>At runtime, call {@code LogSource.setLogImplementation()}.</li>
* </ul>
*
- * @deprecated Use {@link LogFactory} instead - The default factory
+ * @deprecated Use {@link LogFactory} instead. The default factory
* implementation performs exactly the same algorithm as this class did
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/logging/impl/AvalonLogger.java
b/src/main/java/org/apache/commons/logging/impl/AvalonLogger.java
index a097a0e..b53c7e9 100644
--- a/src/main/java/org/apache/commons/logging/impl/AvalonLogger.java
+++ b/src/main/java/org/apache/commons/logging/impl/AvalonLogger.java
@@ -27,6 +27,7 @@ import org.apache.commons.logging.Log;
* logging calls to the Avalon logging abstraction: the Logger interface.
* <p>
* There are two ways in which this class can be used:
+ * </p>
* <ul>
* <li>the instance can be constructed with an Avalon logger
* (by calling {@link #AvalonLogger(Logger)}). In this case, it acts
@@ -48,6 +49,7 @@ import org.apache.commons.logging.Log;
* commons-logging, but this never actually worked (a NullPointerException
would
* be thrown as soon as the deserialized object was used), so removing this
marker
* is not considered to be an incompatible change.
+ * </p>
*
* @deprecated Scheduled for removal because the Apache Avalon Project has
been discontinued.
*/
diff --git a/src/main/java/org/apache/commons/logging/impl/Log4JLogger.java
b/src/main/java/org/apache/commons/logging/impl/Log4JLogger.java
index 9b07074..2250eb7 100644
--- a/src/main/java/org/apache/commons/logging/impl/Log4JLogger.java
+++ b/src/main/java/org/apache/commons/logging/impl/Log4JLogger.java
@@ -30,16 +30,20 @@ import org.apache.log4j.Priority;
* <p>
* Initial configuration of the corresponding Logger instances should be done
* in the usual manner, as outlined in the Log4J documentation.
+ * </p>
* <p>
* The reason this logger is distinct from the 1.3.0 logger is that in version
1.2
* of Log4J:
+ * </p>
* <ul>
* <li>class Logger takes Priority parameters not Level parameters.</li>
* <li>class Level extends Priority</li>
* </ul>
+ * <p>
* Log4j 1.3 is expected to change Level so it no longer extends Priority,
which is
* a non-binary-compatible change. The class generated by compiling this code
against
* Log4j 1.2 will therefore not run against Log4j 1.3.
+ * </p>
*
* @deprecated Scheduled for removal since version 1.x of Log4j has reached
end-of-life.
*/
diff --git
a/src/main/java/org/apache/commons/logging/impl/ServletContextCleaner.java
b/src/main/java/org/apache/commons/logging/impl/ServletContextCleaner.java
index 701f7ea..e428d45 100644
--- a/src/main/java/org/apache/commons/logging/impl/ServletContextCleaner.java
+++ b/src/main/java/org/apache/commons/logging/impl/ServletContextCleaner.java
@@ -38,11 +38,13 @@ import org.apache.commons.logging.LogFactory;
* some rare cases where the WeakHashtable approach does not work; in these
* situations specifying this class as a listener for the web application will
* ensure that all references held by commons-logging are fully released.
+ * </p>
* <p>
* To use this class, configure the webapp deployment descriptor to call
* this class on webapp undeploy; the contextDestroyed method will tell
* every accessible LogFactory class that the entry in its map for the
* current webapp's context class loader should be cleared.
+ * </p>
*
* @since 1.1
*/
