Skip to content

Fix Log4j1SyslogLayout builder javadoc attributes #4239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kalayciburak wants to merge 1 commit into
base: 2.x
Choose a base branch
from
+8 −3
Open

Fix Log4j1SyslogLayout builder javadoc attributes #4239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,19 @@
public final class Log4j1SyslogLayout extends AbstractStringLayout {

/**
* Builds a SyslogLayout.
* Builds a {@link Log4j1SyslogLayout}.
* <p>The main arguments are</p>
* <ul>
* <li>facility: The Facility is used to try to classify the message.</li>
* <li>includeNewLine: If true a newline will be appended to the result.</li>
* <li>escapeNL: Pattern to use for replacing newlines.</li>
* <li>facilityPrinting: If true the facility name is included in the message.</li>
* <li>header: If true a header with local host name and timestamp is included.</li>
* <li>messageLayout: Optional layout used to render the message body.</li>
* <li>charset: The character set.</li>
* </ul>
* <p>
* Unlike {@link org.apache.logging.log4j.core.layout.SyslogLayout}, this layout does not support
* {@code includeNewLine} or {@code escapeNL} options.
* </p>
* @param <B> the builder type
*/
public static class Builder<B extends Builder<B>> extends AbstractStringLayout.Builder<B>
Expand Down