Author: mattsicker
Date: Sun Jun 22 18:54:08 2014
New Revision: 1604640
URL: http://svn.apache.org/r1604640
Log:
Expand on the top level package-info javadoc.
Modified:
logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/package-info.java
Modified:
logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/package-info.java
URL:
http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/package-info.java?rev=1604640&r1=1604639&r2=1604640&view=diff
==============================================================================
---
logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/package-info.java
(original)
+++
logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/package-info.java
Sun Jun 22 18:54:08 2014
@@ -15,6 +15,20 @@
* limitations under the license.
*/
/**
- * Public API for Log4j 2.0.
+ * Public API for Log4j 2.
+ *
+ * <p>
+ * The main entry point into Log4j is the {@link
org.apache.logging.log4j.LogManager} class which can be used to
+ * obtain {@link org.apache.logging.log4j.Logger} objects, the current
+ * {@link org.apache.logging.log4j.spi.LoggerContext}, a new {@code
LoggerContext}, and the current
+ * {@link org.apache.logging.log4j.spi.LoggerContextFactory}.
+ * </p>
+ * <p>
+ * {@link org.apache.logging.log4j.Marker} objects can be obtained through
the
+ * {@link org.apache.logging.log4j.MarkerManager}. The <abbr title="Mapped
Diagnostic Context">MDC</abbr> can be
+ * used through the {@link org.apache.logging.log4j.ThreadContext} class.
+ * </p>
+ *
+ * @see <a href="http://logging.apache.org/log4j/2.x/manual/api.html";>Log4j 2
API manual</a>
*/
package org.apache.logging.log4j;
