Skip to content

Commit bdac6d3

Browse files
committed
Use <a href="link">text</a> instead of markdown syntax in xml doc
So that links are properly rendered in IDEs.
1 parent 0bab61c commit bdac6d3

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/LineEnding.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace Serilog.Formatting.Log4Net;
55
/// <summary>
66
/// Possible XML line endings.
77
/// <para>Both <see cref="CarriageReturn"/> and <see cref="LineFeed"/> can be combined, i.e. <c>LineEnding.CarriageReturn | LineEnding.LineFeed</c> in order to produce the CR+LF characters.</para>
8-
/// <para>See also [End-of-Line Handling](https://www.w3.org/TR/xml/#sec-line-ends) in the XML specification.</para>
8+
/// <para>See also <a href="https://www.w3.org/TR/xml/#sec-line-ends">End-of-Line Handling</a> in the XML specification.</para>
99
/// </summary>
1010
[Flags]
1111
public enum LineEnding

src/Log4NetTextFormatter.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Serilog.Formatting.Log4Net;
1212

1313
/// <summary>
14-
/// A text formatter that serialize log events into [log4net](https://logging.apache.org/log4net/) or [log4j](https://logging.apache.org/log4j/) compatible XML format.
14+
/// A text formatter that serialize log events into <a href="https://logging.apache.org/log4net/">log4net</a> or <a href="https://logging.apache.org/log4j/">log4j</a> compatible XML format.
1515
/// </summary>
1616
public class Log4NetTextFormatter : ITextFormatter
1717
{
@@ -29,19 +29,19 @@ public class Log4NetTextFormatter : ITextFormatter
2929
};
3030

3131
/// <summary>
32-
/// The name of the thread id property, set by [Serilog.Enrichers.Thread](https://www.nuget.org/packages/Serilog.Enrichers.Thread/)
32+
/// The name of the thread id property, set by <a href="https://www.nuget.org/packages/Serilog.Enrichers.Thread/">Serilog.Enrichers.Thread</a>
3333
/// </summary>
3434
/// <remarks>https://github.com/serilog/serilog-enrichers-thread/blob/v3.1.0/src/Serilog.Enrichers.Thread/Enrichers/ThreadIdEnricher.cs#L30</remarks>
3535
private const string ThreadIdPropertyName = "ThreadId";
3636

3737
/// <summary>
38-
/// The name of the user name property, set by [Serilog.Enrichers.Environment](https://www.nuget.org/packages/Serilog.Enrichers.Environment/)
38+
/// The name of the user name property, set by <a href="https://www.nuget.org/packages/Serilog.Enrichers.Environment/">Serilog.Enrichers.Environment</a>
3939
/// </summary>
4040
/// <remarks>https://github.com/serilog/serilog-enrichers-environment/blob/v2.1.3/src/Serilog.Enrichers.Environment/Enrichers/EnvironmentUserNameEnricher.cs#L31</remarks>
4141
private const string UserNamePropertyName = "EnvironmentUserName";
4242

4343
/// <summary>
44-
/// The name of the machine name property, set by [Serilog.Enrichers.Environment](https://www.nuget.org/packages/Serilog.Enrichers.Environment/)
44+
/// The name of the machine name property, set by <a href="https://www.nuget.org/packages/Serilog.Enrichers.Environment/">Serilog.Enrichers.Environment</a>
4545
/// </summary>
4646
/// <remarks>https://github.com/serilog/serilog-enrichers-environment/blob/v2.1.3/src/Serilog.Enrichers.Environment/Enrichers/MachineNameEnricher.cs#L36</remarks>
4747
private const string MachineNamePropertyName = "MachineName";

0 commit comments

Comments
 (0)