svn commit: r1615846 - /logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java

[ma...@apache.org]

Author: mattsicker
Date: Tue Aug  5 02:32:06 2014
New Revision: 1615846

URL: http://svn.apache.org/r1615846
Log:
Fix up javadoc.

Modified:
    logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java

Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java?rev=1615846&r1=1615845&r2=1615846&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Assert.java Tue Aug  5 02:32:06 2014
@@ -31,7 +31,7 @@ public final class Assert {
      * </p>
      * <p>
      * Usage:
-     *
+     * </p>
      * <pre>
      * // earlier you would write this:
      * public SomeConstructor(Object param) {
@@ -49,9 +49,9 @@ public final class Assert {
      *
      * @param <T> the type of the parameter to check and return
      * @param object the parameter to check
-     * @param message name of the parameter to use in the error message if
-     *            {@code null}
+     * @param message message to populate the NPE with if necessary
      * @return the specified parameter
+     * @throws NullPointerException if {@code object} is {@code null}
      */
     public static <T> T requireNonNull(final T object, final String message) {
         if (object == null) {