svn commit: r1420933 - /logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java

[gg...@apache.org]

Author: ggregory
Date: Wed Dec 12 19:49:27 2012
New Revision: 1420933

URL: http://svn.apache.org/viewvc?rev=1420933&view=rev
Log:
Javadoc.

Modified:
    logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java

Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java?rev=1420933&r1=1420932&r2=1420933&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java (original)
+++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/Layout.java Wed Dec 12 19:49:27 2012
@@ -19,15 +19,26 @@ package org.apache.logging.log4j.core;
 import java.io.Serializable;
 
 /**
- * Lays out a {@linkplain LogEvent} in different formats. 
- * The formats are: byte[], or an implementor of {@linkplain Serializable}, like {@code byte[]},
- * String, and LogEvent.
+ * Lays out a {@linkplain LogEvent} in different formats.
  * 
+ * The formats are:
+ * <ul>
+ * <li>
+ * {@code byte[]}</li>
+ * <li>
+ * an implementor of {@linkplain Serializable}, like {@code byte[]}</li>
+ * <li>
+ * {@linkplain String}</li>
+ * <li>
+ * {@linkplain LogEvent}</li>
+ * </ul>
+ * 
+ * @param <T>
+ *            The type returned by {@link #toSerializable(LogEvent)}
+ *            
  * @doubt There is still a need for a character-based layout for character based event sinks (databases, etc). Would introduce an
  *        EventEncoder, EventRenderer or something similar for the logging event to byte encoding. (RG) A layout can be configured with a
  *        Charset and then Strings can be converted to byte arrays. OTOH, it isn't possible to write byte arrays as character streams.
- * @param <T>
- *            The Object type that will be returned on the {@link #toSerializable(LogEvent)} call.
  */
 public interface Layout<T extends Serializable> {
     /**