logging-commits mailing list archives

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

URL: http://svn.apache.org/r1615477
Log:
Fix HTML in javadoc.

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

Modified: logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java?rev=1615477&r1=1615476&r2=1615477&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java
(original)
+++ logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java
Mon Aug  4 02:12:45 2014
@@ -255,9 +255,9 @@ public final class ThreadContext  {
      * Puts a context value (the <code>value</code> parameter) as identified
      * with the <code>key</code> parameter into the current thread's
      * context map.
-     * <p/>
+     *
      * <p>If the current thread does not have a context map it is
-     * created as a side effect.
+     * created as a side effect.</p>
      * @param key The key name.
      * @param value The key value.
      */
@@ -267,8 +267,8 @@ public final class ThreadContext  {
 
     /**
      * Gets the context value identified by the <code>key</code> parameter.
-     * <p/>
-     * <p>This method has no side effects.
+     *
+     * <p>This method has no side effects.</p>
      * @param key The key to locate.
      * @return The value associated with the key or null.
      */
@@ -381,9 +381,9 @@ public final class ThreadContext  {
 
     /**
      * Returns the value of the last item placed on the stack.
-     * <p/>
+     *
      * <p>The returned value is the value that was pushed last. If no
-     * context is available, then the empty string "" is returned.
+     * context is available, then the empty string "" is returned.</p>
      *
      * @return String The innermost diagnostic context.
      */
@@ -394,9 +394,9 @@ public final class ThreadContext  {
     /**
      * 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
-     * context is available, then the empty string "" is returned.
+     * context is available, then the empty string "" is returned.</p>
      *
      * @return String The innermost diagnostic context.
      */
@@ -406,9 +406,9 @@ public final class ThreadContext  {
 
     /**
      * Pushes new diagnostic context information for the current thread.
-     * <p/>
+     *
      * <p>The contents of the <code>message</code> parameter is
-     * determined solely by the client.
+     * determined solely by the client.</p>
      *
      * @param message The new diagnostic context information.
      */
@@ -417,11 +417,11 @@ public final class ThreadContext  {
     }
     /**
      * Pushes new diagnostic context information for the current thread.
-     * <p/>
+     *
      * <p>The contents of the <code>message</code> and args parameters
are
      * determined solely by the client. The message will be treated as a format String
      * and tokens will be replaced with the String value of the arguments in accordance
-     * with ParameterizedMessage.
+     * with ParameterizedMessage.</p>
      *
      * @param message The new diagnostic context information.
      * @param args Parameters for the message.
@@ -432,12 +432,12 @@ public final class ThreadContext  {
 
     /**
      * Removes the diagnostic context for this thread.
-     * <p/>
+     *
      * <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/>
+     * VM.</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
@@ -446,7 +446,7 @@ public final class ThreadContext  {
      * occasionally forget to call {@link #remove} before exiting a
      * thread. However, you must call <code>remove</code> sometime. If
      * you never call it, then your application is sure to run out of
-     * memory.
+     * memory.</p>
      */
     public static void removeStack() {
         contextStack.clear();
@@ -457,26 +457,26 @@ public final class ThreadContext  {
      * depth is smaller or equal to <code>maxDepth</code>, then no
      * action is taken. If the current depth is larger than newDepth
      * then all elements at maxDepth or higher are discarded.
-     * <p/>
+     *
      * <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 ThreadContext is
      * unpredictable. The <code>trim</code> method circumvents
-     * this problem.
-     * <p/>
-     * <p>For example, the combination
+     * this problem.</p>
+     *
+     * <p>For example, the combination</p>
      * <pre>
      * void foo() {
-     * &nbsp;  int depth = ThreadContext.getDepth();
-     * <p/>
-     * &nbsp;  ... complex sequence of calls
-     * <p/>
-     * &nbsp;  ThreadContext.trim(depth);
+     *     final int depth = ThreadContext.getDepth();
+     *
+     *     // ... complex sequence of calls
+     *
+     *     ThreadContext.trim(depth);
      * }
      * </pre>
-     * <p/>
-     * ensures that between the entry and exit of foo the depth of the
-     * diagnostic stack is conserved.
+     *
+     * <p>ensures that between the entry and exit of {@code foo} the depth of the
+     * diagnostic stack is conserved.</p>
      *
      * @see #getDepth
      * @param depth The number of elements to keep.



Mime
View raw message