svn commit: r1615473 - /logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java

[ma...@apache.org]

Author: mattsicker
Date: Mon Aug  4 02:12:34 2014
New Revision: 1615473

URL: http://svn.apache.org/r1615473
Log:
Update javadoc.

Modified:
    logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java

Modified: logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java?rev=1615473&r1=1615472&r2=1615473&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java (original)
+++ logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java Mon Aug  4 02:12:34 2014
@@ -20,7 +20,9 @@ import java.security.AccessController;
 import java.security.PrivilegedAction;
 
 /**
- * Utility class for ClassLoaders. Consider this class private.
+ * <em>Consider this class private.</em> Utility class for ClassLoaders.
+ * @see ClassLoader
+ * @see Thread#getContextClassLoader()
  */
 // TODO: migrate any other useful methods from Loader in log4j-core
 public final class LoaderUtil {
@@ -35,6 +37,11 @@ public final class LoaderUtil {
         }
     }
 
+    /**
+     * Gets the current Thread ClassLoader. Returns the system ClassLoader if the TCCL is {@code null}.
+     *
+     * @return the current ThreadContextClassLoader.
+     */
     public static ClassLoader getThreadContextClassLoader() {
         return System.getSecurityManager() == null
             ? TCCL_GETTER.run()