From 6257078add3d40fcba7b31ffe589468e54b4326f Mon Sep 17 00:00:00 2001 From: Thomas Neidhart Date: Thu, 26 Jun 2014 20:11:57 +0000 Subject: [PATCH] =?UTF-8?q?[LOGGING-157]=20Fix=20javadoc.=20Thanks=20to=20?= =?UTF-8?q?Ville=20Skytt=C3=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit git-svn-id: https://svn.apache.org/repos/asf/commons/proper/logging/trunk@1605899 13f79535-47bb-0310-9956-ffa450edef68 --- src/changes/changes.xml | 3 +++ src/main/java/org/apache/commons/logging/Log.java | 4 ++-- .../java/org/apache/commons/logging/LogFactory.java | 12 ++++++------ .../apache/commons/logging/AltHashtableTestCase.java | 2 +- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 60a4600..f601e2a 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -44,6 +44,9 @@ The type attribute can be add,update,fix,remove. + + Fix javadoc to comply with javadoc tool from jdk 1.8. + diff --git a/src/main/java/org/apache/commons/logging/Log.java b/src/main/java/org/apache/commons/logging/Log.java index 947c3e6..049ce3f 100644 --- a/src/main/java/org/apache/commons/logging/Log.java +++ b/src/main/java/org/apache/commons/logging/Log.java @@ -43,12 +43,12 @@ package org.apache.commons.logging; * to be logged). *

* For example, - *

+ * 
  *    if (log.isDebugEnabled()) {
  *        ... do something expensive ...
  *        log.debug(theResult);
  *    }
- * 
+ *
*

* Configuration of the underlying logging system will generally be done * external to the Logging APIs, through whatever mechanism is supported by diff --git a/src/main/java/org/apache/commons/logging/LogFactory.java b/src/main/java/org/apache/commons/logging/LogFactory.java index 30a3dbe..52e3891 100644 --- a/src/main/java/org/apache/commons/logging/LogFactory.java +++ b/src/main/java/org/apache/commons/logging/LogFactory.java @@ -151,23 +151,23 @@ public abstract class LogFactory { * classloaders to be substituted by an alternative implementation. *

* Note: LogFactory will print: - *

-     * [ERROR] LogFactory: Load of custom hashtable failed
-     * 
+ *
+     * [ERROR] LogFactory: Load of custom hashtable failed
+     * 
* to system error and then continue using a standard Hashtable. *

* Usage: Set this property when Java is invoked * and LogFactory will attempt to load a new instance * of the given implementation class. * For example, running the following ant scriplet: - *

+     * 
      *  <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
      *     ...
      *     <sysproperty
      *        key="org.apache.commons.logging.LogFactory.HashtableImpl"
      *        value="org.apache.commons.logging.AltHashtable"/>
      *  </java>
-     * 
+ *
* will mean that LogFactory will load an instance of * org.apache.commons.logging.AltHashtable. *

@@ -951,8 +951,8 @@ public abstract class LogFactory { * implementation class, loaded by the specified class loader. * If that fails, try the class loader used to load this * (abstract) LogFactory. - *

*

ClassLoader conflicts

+ *

* Note that there can be problems if the specified ClassLoader is not the * same as the classloader that loaded this class, ie when loading a * concrete LogFactory subclass via a context classloader. diff --git a/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java b/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java index c70d884..8c8e01c 100644 --- a/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java +++ b/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java @@ -23,7 +23,7 @@ import junit.framework.TestCase; /** * Test the ability to force the LogFactory class to use some * arbitrary Hashtable implementation to store its mapping from - * context-classloader -> LogFactory object. + * context-classloader -> LogFactory object. */ public class AltHashtableTestCase extends TestCase {