logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mattsic...@apache.org
Subject svn commit: r1615476 - /logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java
Date Mon, 04 Aug 2014 02:12:43 GMT
Author: mattsicker
Date: Mon Aug  4 02:12:42 2014
New Revision: 1615476

URL: http://svn.apache.org/r1615476
Log:
Elaborate the LogManager intro javadoc.

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

Modified: logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java?rev=1615476&r1=1615475&r2=1615476&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java
(original)
+++ logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java
Mon Aug  4 02:12:42 2014
@@ -34,7 +34,13 @@ import org.apache.logging.log4j.util.Pro
 import org.apache.logging.log4j.util.Strings;
 
 /**
- * The anchor point for the logging system.
+ * The anchor point for the logging system. The most common usage of this class is to obtain
a named
+ * {@link Logger}. The method {@link #getLogger()} is provided as the most convenient way
to obtain a named Logger
+ * based on the calling class name. This class also provides method for obtaining named Loggers
that use
+ * {@link String#format(String, Object...)} style messages instead of the default type of
parameterized messages.
+ * These are obtained through the {@link #getFormatterLogger(Class)} family of methods. Other
service provider methods
+ * are given through the {@link #getContext()} and {@link #getFactory()} family of methods;
these methods are not
+ * normally useful for typical usage of Log4j.
  */
 public class LogManager {
 



Mime
View raw message