Skip to content

Commit 2874864

Browse files
committed
Improve wording in xmldoc
1 parent 5c4f5de commit 2874864

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/Log4NetTextFormatter.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class Log4NetTextFormatter : ITextFormatter
3636
private const string ThreadIdPropertyName = "ThreadId";
3737

3838
/// <summary>
39-
/// The name of the user name property, set by <a href="https://www.nuget.org/packages/Serilog.Enrichers.Environment/">Serilog.Enrichers.Environment</a>
39+
/// The name of the username property, set by <a href="https://www.nuget.org/packages/Serilog.Enrichers.Environment/">Serilog.Enrichers.Environment</a>
4040
/// </summary>
4141
/// <remarks>https://github.com/serilog/serilog-enrichers-environment/blob/v2.1.3/src/Serilog.Enrichers.Environment/Enrichers/EnvironmentUserNameEnricher.cs#L31</remarks>
4242
private const string UserNamePropertyName = "EnvironmentUserName";
@@ -112,7 +112,7 @@ public void Format(LogEvent logEvent, TextWriter output)
112112
{
113113
// log4j writes the XML "manually", see https://github.com/apache/log4j/blob/v1_2_17/src/main/java/org/apache/log4j/xml/XMLLayout.java#L137-L145
114114
// The resulting XML is impossible to write with a standard compliant XML writer such as XmlWriter.
115-
// That's why we write the event in a StringWriter then massage the output to remove the xmlns:log4j attribute to match log4j output.
115+
// That's why we write the event in a StringWriter then tweak the output to remove the xmlns:log4j attribute to match log4j output.
116116
// The XML fragment becomes valid when surrounded by an external entity, see https://github.com/apache/log4j/blob/v1_2_17/src/main/java/org/apache/log4j/xml/XMLLayout.java#L31-L49
117117
const string log4JNamespaceAttribute = """
118118
xmlns:log4j="http://jakarta.apache.org/log4j/"
@@ -193,7 +193,7 @@ private static void WriteDomainAndUserName(LogEvent logEvent, XmlWriter writer)
193193
/// <param name="writer">The XML writer.</param>
194194
/// <param name="attributeName">The name of the XML attribute.</param>
195195
/// <param name="propertyName">The name of the Serilog property.</param>
196-
/// <remarks>Only properties with a non null <see cref="ScalarValue"/> are supported, other types are ignored.</remarks>
196+
/// <remarks>Only properties with a non-null <see cref="ScalarValue"/> are supported, other types are ignored.</remarks>
197197
private void WriteEventAttribute(LogEvent logEvent, XmlWriter writer, string attributeName, string propertyName)
198198
{
199199
if (logEvent.Properties.TryGetValue(propertyName, out var propertyValue) && propertyValue is ScalarValue { Value: not null })

0 commit comments

Comments
 (0)