Repository: logging-log4j2 Updated Branches: refs/heads/master b90f18878 -> ef6183cde
Javadoc 8 fixes. Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/ef6183cd Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/ef6183cd Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/ef6183cd Branch: refs/heads/master Commit: ef6183cdeec2493172c1aba5ec50b6efd0748760 Parents: b90f188 Author: Gary Gregory <[email protected]> Authored: Mon Sep 22 01:50:15 2014 -0400 Committer: Gary Gregory <[email protected]> Committed: Mon Sep 22 01:50:15 2014 -0400 ---------------------------------------------------------------------- .../main/java/org/apache/log4j/Appender.java | 5 +- .../src/main/java/org/apache/log4j/Level.java | 2 +- .../src/main/java/org/apache/log4j/NDC.java | 77 +++++++++++--------- .../main/java/org/apache/log4j/Priority.java | 5 +- .../java/org/apache/log4j/spi/ErrorHandler.java | 5 +- 5 files changed, 53 insertions(+), 41 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/ef6183cd/log4j-1.2-api/src/main/java/org/apache/log4j/Appender.java ---------------------------------------------------------------------- diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/Appender.java b/log4j-1.2-api/src/main/java/org/apache/log4j/Appender.java index dd543bd..de89cce 100644 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/Appender.java +++ b/log4j-1.2-api/src/main/java/org/apache/log4j/Appender.java @@ -129,10 +129,11 @@ public interface Appender { * a layout is not required, then layout configuration will be * skipped even if there is available layout configuration * information at the disposal of the configurator.. - * <p/> - * <p>In the rather exceptional case, where the appender + * <p> + * In the rather exceptional case, where the appender * implementation admits a layout but can also work without it, then * the appender should return {@code true}. + * </p> * @return true if a Layout is required. * * @since 0.8.4 http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/ef6183cd/log4j-1.2-api/src/main/java/org/apache/log4j/Level.java ---------------------------------------------------------------------- diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/Level.java b/log4j-1.2-api/src/main/java/org/apache/log4j/Level.java index 6bb8013..e997f4b 100644 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/Level.java +++ b/log4j-1.2-api/src/main/java/org/apache/log4j/Level.java @@ -27,7 +27,7 @@ import org.apache.logging.log4j.util.Strings; /** * Defines the minimum set of levels recognized by the system, that is * <code>OFF</code>, <code>FATAL</code>, <code>ERROR</code>, - * <code>WARN</code>, <code>INFO</code, <code>DEBUG</code> + * <code>WARN</code>, <code>INFO</code>, <code>DEBUG</code> * and <code>ALL</code>. * <p> * The <code>Level</code> class may be subclassed to define a larger http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/ef6183cd/log4j-1.2-api/src/main/java/org/apache/log4j/NDC.java ---------------------------------------------------------------------- diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/NDC.java b/log4j-1.2-api/src/main/java/org/apache/log4j/NDC.java index 8b9214b..0b8b4e8 100644 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/NDC.java +++ b/log4j-1.2-api/src/main/java/org/apache/log4j/NDC.java @@ -30,9 +30,10 @@ public final class NDC { * Clear any nested diagnostic information if any. This method is * useful in cases where the same thread can be potentially used * over and over in different unrelated contexts. - * <p/> - * <p>This method is equivalent to calling the {@link #setMaxDepth} + * <p> + * This method is equivalent to calling the {@link #setMaxDepth} * method with a zero <code>maxDepth</code> argument. + * </p> */ public static void clear() { org.apache.logging.log4j.ThreadContext.clearStack(); @@ -41,15 +42,16 @@ public final class NDC { /** * Clone the diagnostic context for the current thread. - * <p/> - * <p>Internally a diagnostic context is represented as a stack. A + * <p> + * Internally a diagnostic context is represented as a stack. A * given thread can supply the stack (i.e. diagnostic context) to a * child thread so that the child can inherit the parent thread's * diagnostic context. - * <p/> - * <p>The child thread uses the {@link #inherit inherit} method to + * </p> + * <p> + * The child thread uses the {@link #inherit inherit} method to * inherit the parent's diagnostic context. - * + * </p> * @return Stack A clone of the current thread's diagnostic context. */ @SuppressWarnings("rawtypes") @@ -64,21 +66,23 @@ public final class NDC { /** * Inherit the diagnostic context of another thread. - * <p/> - * <p>The parent thread can obtain a reference to its diagnostic + * <p> + * The parent thread can obtain a reference to its diagnostic * context using the {@link #cloneStack} method. It should * communicate this information to its child so that it may inherit * the parent's diagnostic context. - * <p/> - * <p>The parent's diagnostic context is cloned before being + * </p> + * <p> + * The parent's diagnostic context is cloned before being * inherited. In other words, once inherited, the two diagnostic * contexts can be managed independently. - * <p/> - * <p>In java, a child thread cannot obtain a reference to its + * </p> + * <p> + * In java, a child thread cannot obtain a reference to its * parent, unless it is directly handed the reference. Consequently, * there is no client-transparent way of inheriting diagnostic * contexts. Do you know any solution to this problem? - * + * </p> * @param stack The diagnostic context of the parent thread. */ public static void inherit(final Stack<String> stack) { @@ -106,10 +110,10 @@ public final class NDC { /** * Clients should call this method before leaving a diagnostic * context. - * <p/> - * <p>The returned value is the value that was pushed last. If no + * <p> + * The returned value is the value that was pushed last. If no * context is available, then the empty string "" is returned. - * + * </p> * @return String The innermost diagnostic context. */ public static String pop() { @@ -119,10 +123,10 @@ public final class NDC { /** * Looks at the last diagnostic context at the top of this NDC * without removing it. - * <p/> - * <p>The returned value is the value that was pushed last. If no + * <p> + * The returned value is the value that was pushed last. If no * context is available, then the empty string "" is returned. - * + * </p> * @return String The innermost diagnostic context. */ public static String peek() { @@ -131,10 +135,10 @@ public final class NDC { /** * Push new diagnostic context information for the current thread. - * <p/> - * <p>The contents of the <code>message</code> parameter is + * <p> + * The contents of the <code>message</code> parameter is * determined solely by the client. - * + * </p> * @param message The new diagnostic context information. */ public static void push(final String message) { @@ -143,13 +147,14 @@ public final class NDC { /** * Remove the diagnostic context for this thread. - * <p/> - * <p>Each thread that created a diagnostic context by calling + * <p> + * Each thread that created a diagnostic context by calling * {@link #push} should call this method before exiting. Otherwise, * the memory used by the <b>thread</b> cannot be reclaimed by the * VM. - * <p/> - * <p>As this is such an important problem in heavy duty systems and + * </p> + * <p> + * As this is such an important problem in heavy duty systems and * because it is difficult to always guarantee that the remove * method is called before exiting a thread, this method has been * augmented to lazily remove references to dead threads. In @@ -158,6 +163,7 @@ public final class NDC { * thread. However, you must call <code>remove</code> sometime. If * you never call it, then your application is sure to run out of * memory. + * </p> */ public static void remove() { org.apache.logging.log4j.ThreadContext.removeStack(); @@ -167,26 +173,29 @@ public final class NDC { * Set maximum depth of this diagnostic context. If the current * depth is smaller or equal to <code>maxDepth</code>, then no * action is taken. - * <p/> - * <p>This method is a convenient alternative to multiple {@link + * <p> + * This method is a convenient alternative to multiple {@link * #pop} calls. Moreover, it is often the case that at the end of * complex call sequences, the depth of the NDC is * unpredictable. The <code>setMaxDepth</code> method circumvents * this problem. - * <p/> - * <p>For example, the combination + * </p> + * <p> + * For example, the combination + * </p> * <pre> * void foo() { * int depth = NDC.getDepth(); - * <p/> + * * ... complex sequence of calls - * <p/> + * * NDC.setMaxDepth(depth); * } * </pre> - * <p/> + * <p> * ensures that between the entry and exit of foo the depth of the * diagnostic stack is conserved. + * </p> * * @see #getDepth * @param maxDepth The maximum depth of the stack. http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/ef6183cd/log4j-1.2-api/src/main/java/org/apache/log4j/Priority.java ---------------------------------------------------------------------- diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/Priority.java b/log4j-1.2-api/src/main/java/org/apache/log4j/Priority.java index 7bf0065..10759d1 100644 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/Priority.java +++ b/log4j-1.2-api/src/main/java/org/apache/log4j/Priority.java @@ -153,9 +153,10 @@ public class Priority { * Returns {@code true} if this level has a higher or equal * level than the level passed as argument, {@code false} * otherwise. - * <p/> - * <p>You should think twice before overriding the default + * <p> + * You should think twice before overriding the default * implementation of <code>isGreaterOrEqual</code> method. + * </p> * @param r The Priority to check. * @return true if the current level is greater or equal to the specified Priority. */ http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/ef6183cd/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ErrorHandler.java ---------------------------------------------------------------------- diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ErrorHandler.java b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ErrorHandler.java index 9e3f57f..2e64103 100644 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ErrorHandler.java +++ b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ErrorHandler.java @@ -24,10 +24,11 @@ import org.apache.log4j.Logger; * Appenders may delegate their error handling to * <code>ErrorHandlers</code>. * <p> - * <p>Error handling is a particularly tedious to get right because by + * Error handling is a particularly tedious to get right because by * definition errors are hard to predict and to reproduce. * </p> - * <p>Please take the time to contact the author in case you discover + * <p> + * Please take the time to contact the author in case you discover * that errors are not properly handled. You are most welcome to * suggest new error handling policies or criticize existing policies. * </p>
