Add some JavaDocs.

Correct JavaDocs.
Replace tab-characters with spaces.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@399225 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/logging/LogFactory.java

@@ -139,7 +139,7 @@ public abstract class LogFactory {
      * <strong>Note:</strong> <code>LogFactory</code> will print:
      * <code><pre>
      * [ERROR] LogFactory: Load of custom hashtable failed</em>
-     * </code></pre>
+     * </pre></code>
      * to system error and then continue using a standard Hashtable.
      * </p>
      * <p>
@@ -571,7 +571,7 @@ public abstract class LogFactory {
                     }
                     factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);
                     
-                    // what about handling an exception from newFactory??
+                    // TODO: think about whether we need to handle exceptions from newFactory
                 } else {
                     if (isDiagnosticsEnabled()) {
                         logDiagnostic(
@@ -1169,7 +1169,7 @@ public abstract class LogFactory {
              * classLoader was unable to load factoryClass.
              *
              * In either case, we call Class.forName, which is equivalent
-             * to LogFactory.class.getClassLoader.load(name), ie we ignore
+             * to LogFactory.class.getClassLoader().load(name), ie we ignore
              * the classloader parameter the caller passed, and fall back
              * to trying the classloader associated with this class. See the
              * javadoc for the newFactory method for more info on the 
@@ -1214,7 +1214,9 @@ public abstract class LogFactory {
      * of incompatibility. The test used is whether the class is assignable from
      * the <code>LogFactory</code> class loaded by the class's classloader.
      * @param logFactoryClass <code>Class</code> which may implement <code>LogFactory</code>
-     * @return true if the <code>Class</code> is assignable from the 
+     * @return true if the <code>logFactoryClass</code> does extend
+     * <code>LogFactory</code> when that class is loaded via the same
+     * classloader that loaded the <code>logFactoryClass</code>.
      */
     private static boolean implementsLogFactory(Class logFactoryClass) {
         boolean implementsLogFactory = false;
@@ -1474,7 +1476,7 @@ public abstract class LogFactory {
     /**
      * Determines whether the user wants internal diagnostic output. If so,
      * returns an appropriate writer object. Users can enable diagnostic
-     * output by setting the system property named OUTPUT_PROPERTY to
+     * output by setting the system property named DIAGNOSTICS_DEST_PROPERTY to
      * a filename, or the special values STDOUT or STDERR. 
      */
     private static void initDiagnostics() {