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 cce2a09 Javadoc
cce2a09 is described below
commit cce2a097ec976eb9657d49831554851818f405fc
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:59 2026 -0400
Javadoc
---
.../java/org/apache/commons/logging/LogFactory.java | 20 ++++++++++----------
.../java/org/apache/commons/logging/LogSource.java | 8 ++++----
.../apache/commons/logging/impl/LogFactoryImpl.java | 2 +-
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/logging/LogFactory.java
b/src/main/java/org/apache/commons/logging/LogFactory.java
index aa3253c..813fb57 100644
--- a/src/main/java/org/apache/commons/logging/LogFactory.java
+++ b/src/main/java/org/apache/commons/logging/LogFactory.java
@@ -566,7 +566,7 @@ public abstract class LogFactory {
* </p>
*
* @param clazz Class.
- * @return a ClassLoader.
+ * @return A ClassLoader.
* @since 1.1
*/
protected static ClassLoader getClassLoader(final Class<?> clazz) {
@@ -719,7 +719,7 @@ public abstract class LogFactory {
* <em>NOTE</em> - In a multi-threaded environment it is possible that two
different instances will be returned for the same class loader environment.
* </p>
*
- * @return a {@code LogFactory}.
+ * @return A {@code LogFactory}.
* @throws LogConfigurationException if the implementation class is not
available or cannot be instantiated.
*/
public static LogFactory getFactory() throws LogConfigurationException {
@@ -914,7 +914,7 @@ public abstract class LogFactory {
* Gets a named logger, without the application having to care about
factories.
*
* @param clazz Class from which a log name will be derived
- * @return a named logger.
+ * @return A named logger.
* @throws LogConfigurationException if a suitable {@code Log} instance
cannot be returned
*/
public static Log getLog(final Class<?> clazz) throws
LogConfigurationException {
@@ -926,7 +926,7 @@ public abstract class LogFactory {
*
* @param name Logical name of the {@code Log} instance to be returned
(the meaning of this name is only known to the underlying logging
implementation that
* is being wrapped)
- * @return a named logger.
+ * @return A named logger.
* @throws LogConfigurationException if a suitable {@code Log} instance
cannot be returned
*/
public static Log getLog(final String name) throws
LogConfigurationException {
@@ -1345,7 +1345,7 @@ public abstract class LogFactory {
*
* @param factoryClass factory class.
* @param classLoader class loader.
- * @return a LogFactory.
+ * @return A LogFactory.
*/
protected static LogFactory newFactory(final String factoryClass,
final ClassLoader classLoader) {
@@ -1382,7 +1382,7 @@ public abstract class LogFactory {
* @param factoryClass Fully qualified name of the {@code
LogFactory} implementation class
* @param classLoader ClassLoader from which to load this class
* @param contextClassLoader is the context that this new factory will
manage logging for.
- * @return a new instance of the specified {@code LogFactory}.
+ * @return A new instance of the specified {@code LogFactory}.
* @throws LogConfigurationException if a suitable instance cannot be
created
* @since 1.1
*/
@@ -1453,7 +1453,7 @@ public abstract class LogFactory {
* </p>
*
* @param obj may be null.
- * @return a string of form {@code className@hashCode}, or "null" if obj
is null.
+ * @return A string of form {@code className@hashCode}, or "null" if obj
is null.
* @since 1.1
*/
public static String objectId(final Object obj) {
@@ -1536,7 +1536,7 @@ public abstract class LogFactory {
/**
* Gets an array containing the names of all currently defined
configuration attributes. If there are no such attributes, a zero length array
is returned.
*
- * @return an array containing the names of all currently defined
configuration attributes
+ * @return An array containing the names of all currently defined
configuration attributes
*/
public abstract String[] getAttributeNames();
@@ -1544,7 +1544,7 @@ public abstract class LogFactory {
* Gets a Log for the given class.
*
* @param clazz Class for which a suitable Log name will be derived
- * @return a name from the specified class.
+ * @return A name from the specified class.
* @throws LogConfigurationException if a suitable {@code Log} instance
cannot be returned
*/
public abstract Log getInstance(Class<?> clazz) throws
LogConfigurationException;
@@ -1558,7 +1558,7 @@ public abstract class LogFactory {
*
* @param name Logical name of the {@code Log} instance to be returned
(the meaning of this name is only known to the underlying logging
implementation that
* is being wrapped)
- * @return a {@code Log} instance.
+ * @return A {@code Log} instance.
* @throws LogConfigurationException if a suitable {@code Log} instance
cannot be returned
*/
public abstract Log getInstance(String name)
diff --git a/src/main/java/org/apache/commons/logging/LogSource.java
b/src/main/java/org/apache/commons/logging/LogSource.java
index bd737b3..f7fe666 100644
--- a/src/main/java/org/apache/commons/logging/LogSource.java
+++ b/src/main/java/org/apache/commons/logging/LogSource.java
@@ -126,7 +126,7 @@ public class LogSource {
* Gets a {@code Log} instance by class.
*
* @param clazz a Class.
- * @return a {@code Log} instance.
+ * @return A {@code Log} instance.
*/
static public Log getInstance(final Class<?> clazz) {
return getInstance(clazz.getName());
@@ -136,7 +136,7 @@ public class LogSource {
* Gets a {@code Log} instance by class name.
*
* @param name Class name.
- * @return a {@code Log} instance.
+ * @return A {@code Log} instance.
*/
static public Log getInstance(final String name) {
return logs.computeIfAbsent(name, k -> makeNewLogInstance(name));
@@ -146,7 +146,7 @@ public class LogSource {
* Returns a {@link String} array containing the names of
* all logs known to me.
*
- * @return a {@link String} array containing the names of
+ * @return A {@link String} array containing the names of
* all logs known to me.
*/
static public String[] getLogNames() {
@@ -178,7 +178,7 @@ public class LogSource {
* are on a JDK 1.4 or later system, or NoOpLog if neither of the above
conditions is true.
*
* @param name the log name (or category)
- * @return a new instance.
+ * @return A new instance.
*/
static public Log makeNewLogInstance(final String name) {
Log log;
diff --git a/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
b/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
index 0a252b3..05c2fe2 100644
--- a/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
+++ b/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
@@ -1161,7 +1161,7 @@ public class LogFactoryImpl extends LogFactory {
* Create and return a new {@link org.apache.commons.logging.Log} instance
for the specified name.
*
* @param name Name of the new logger
- * @return a new {@link org.apache.commons.logging.Log}
+ * @return A new {@link org.apache.commons.logging.Log}
* @throws LogConfigurationException if a new instance cannot be created
*/
protected Log newInstance(final String name) throws
LogConfigurationException {
