This is an automated email from the ASF dual-hosted git repository. pkarwasz pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 7a8ef005f8a8f87db6b1fa39f94442abb90904c8 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Fri Nov 10 19:43:21 2023 +0100 Fix Javadoc tags --- log4j-api/src/main/java/org/apache/logging/log4j/Logger.java | 2 +- .../org/apache/logging/log4j/jackson/json/layout/JsonLayout.java | 8 ++++---- .../org/apache/logging/log4j/jackson/xml/layout/XmlLayout.java | 8 ++++---- .../org/apache/logging/log4j/jackson/yaml/layout/YamlLayout.java | 4 ++-- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java b/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java index 7a312fd0f6..ff44e34044 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java @@ -69,7 +69,7 @@ import org.apache.logging.log4j.util.Supplier; * </pre> * * <p> - * Note that although {@link MessageSupplier} is provided, using {@link Supplier<Message>} works just the + * Note that although {@link MessageSupplier} is provided, using {@link Supplier Supplier<Message>} works just the * same. MessageSupplier was deprecated in 2.6 and un-deprecated in 2.8.1. Anonymous class usage of these APIs * should prefer using Supplier instead. * </p> diff --git a/log4j-layout-jackson-json/src/main/java/org/apache/logging/log4j/jackson/json/layout/JsonLayout.java b/log4j-layout-jackson-json/src/main/java/org/apache/logging/log4j/jackson/json/layout/JsonLayout.java index af888adbf5..c098df9851 100644 --- a/log4j-layout-jackson-json/src/main/java/org/apache/logging/log4j/jackson/json/layout/JsonLayout.java +++ b/log4j-layout-jackson-json/src/main/java/org/apache/logging/log4j/jackson/json/layout/JsonLayout.java @@ -46,7 +46,7 @@ import org.apache.logging.log4j.plugins.PluginFactory; * * Appends a series of JSON events as strings serialized as bytes. * - * <h3>Complete well-formed JSON vs. fragment JSON</h3> + * <h2>Complete well-formed JSON vs. fragment JSON</h2> * <p> * If you configure {@code complete="true"}, the appender outputs a well-formed JSON document. By default, with * {@code complete="false"}, you should include the output as an <em>external file</em> in a separate file to form a @@ -56,18 +56,18 @@ import org.apache.logging.log4j.plugins.PluginFactory; * If {@code complete="false"}, the appender does not write the JSON open array character "[" at the start * of the document, "]" and the end, nor comma "," between records. * </p> - * <h3>Encoding</h3> + * <h2>Encoding</h2> * <p> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise * events containing non ASCII characters could result in corrupted log files. * </p> - * <h3>Pretty vs. compact JSON</h3> + * <h2>Pretty vs. compact JSON</h2> * <p> * By default, the JSON layout is not compact (a.k.a. "pretty") with {@code compact="false"}, which means the * appender uses end-of-line characters and indents lines to format the text. If {@code compact="true"}, then no * end-of-line or indentation is used. Message content may contain, of course, escaped end-of-lines. * </p> - * <h3>Additional Fields</h3> + * <h2>Additional Fields</h2> * <p> * This property allows addition of custom fields into generated JSON. * {@code <JsonLayout><KeyValuePair key="foo" value="bar"/></JsonLayout>} inserts {@code "foo":"bar"} directly diff --git a/log4j-layout-jackson-xml/src/main/java/org/apache/logging/log4j/jackson/xml/layout/XmlLayout.java b/log4j-layout-jackson-xml/src/main/java/org/apache/logging/log4j/jackson/xml/layout/XmlLayout.java index 7e37e94923..d63ccb55b5 100644 --- a/log4j-layout-jackson-xml/src/main/java/org/apache/logging/log4j/jackson/xml/layout/XmlLayout.java +++ b/log4j-layout-jackson-xml/src/main/java/org/apache/logging/log4j/jackson/xml/layout/XmlLayout.java @@ -37,7 +37,7 @@ import org.apache.logging.log4j.plugins.PluginFactory; /** * Appends a series of {@code event} elements as defined in the <a href="log4j.dtd">log4j.dtd</a>. * - * <h3>Complete well-formed XML vs. fragment XML</h3> + * <h2>Complete well-formed XML vs. fragment XML</h2> * <p> * If you configure {@code complete="true"}, the appender outputs a well-formed XML document where the default namespace * is the log4j namespace {@value XmlConstants#XML_NAMESPACE}. By default, with {@code complete="false"}, you should @@ -46,18 +46,18 @@ import org.apache.logging.log4j.plugins.PluginFactory; * <p> * If {@code complete="false"}, the appender does not write the XML processing instruction and the root element. * </p> - * <h3>Encoding</h3> + * <h2>Encoding</h2> * <p> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise * events containing non-ASCII characters could result in corrupted log files. * </p> - * <h3>Pretty vs. compact XML</h3> + * <h2>Pretty vs. compact XML</h2> * <p> * By default, the XML layout is not compact (compact = not "pretty") with {@code compact="false"}, which means the * appender uses end-of-line characters and indents lines to format the XML. If {@code compact="true"}, then no * end-of-line or indentation is used. Message content may contain, of course, end-of-lines. * </p> - * <h3>Additional Fields</h3> + * <h2>Additional Fields</h2> * <p> * This property allows addition of custom fields into generated JSON. * {@code <XmlLayout><KeyValuePair key="foo" value="bar"/></XmlLayout>} inserts {@code <foo>bar</foo>} directly into XML diff --git a/log4j-layout-jackson-yaml/src/main/java/org/apache/logging/log4j/jackson/yaml/layout/YamlLayout.java b/log4j-layout-jackson-yaml/src/main/java/org/apache/logging/log4j/jackson/yaml/layout/YamlLayout.java index d0a0c5df0e..46b5f85c04 100644 --- a/log4j-layout-jackson-yaml/src/main/java/org/apache/logging/log4j/jackson/yaml/layout/YamlLayout.java +++ b/log4j-layout-jackson-yaml/src/main/java/org/apache/logging/log4j/jackson/yaml/layout/YamlLayout.java @@ -40,12 +40,12 @@ import org.apache.logging.log4j.util.Strings; /** * Appends a series of YAML events as strings serialized as bytes. * - * <h3>Encoding</h3> + * <h2>Encoding</h2> * <p> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise * events containing non ASCII characters could result in corrupted log files. * </p> - * <h3>Additional Fields</h3> + * <h2>Additional Fields</h2> * <p> * This property allows addition of custom fields into generated JSON. * {@code <YamlLayout><KeyValuePair key="foo" value="bar"/></YamlLayout>} inserts {@code foo: "bar"} directly into YAML
