Skip to content

Commit 2a11efb

Browse files
authored
Added Wiki Links to XML docs (#5497)
1 parent 788b285 commit 2a11efb

File tree

77 files changed

+303
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+303
-8
lines changed

src/NLog/LayoutRenderers/ApplicationEnvironment/AppDomainLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// Used to render the application domain name.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/AppDomain-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/AppDomain-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("appdomain")]
4650
[AppDomainFixedOutput]
4751
[ThreadAgnostic]

src/NLog/LayoutRenderers/ApplicationEnvironment/AppSettingLayoutRenderer.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ namespace NLog.LayoutRenderers
4242
using NLog.Internal;
4343

4444
/// <summary>
45-
/// Application setting.
45+
/// Render value for Application setting retrieved from App.config or Web.config file.
4646
/// </summary>
4747
/// <remarks>
48-
/// Use this layout renderer to insert the value of an application setting
49-
/// stored in the application's App.config or Web.config file.
50-
/// </remarks>
5148
/// <code lang="NLog Layout Renderer">
5249
/// ${appsetting:item=mysetting:default=mydefault} - produces "mydefault" if no appsetting
5350
/// </code>
51+
/// <a href="https://github.com/NLog/NLog/wiki/AppSetting-Layout-Renderer">See NLog Wiki</a>
52+
/// </remarks>
53+
/// <seealso href="https://github.com/NLog/NLog/wiki/AppSetting-Layout-Renderer">Documentation on NLog Wiki</seealso>
5454
[LayoutRenderer("appsetting")]
5555
[ThreadAgnostic]
5656
public sealed class AppSettingLayoutRenderer : LayoutRenderer, IStringValueRenderer

src/NLog/LayoutRenderers/ApplicationEnvironment/AssemblyVersionLayoutRenderer.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,9 @@ namespace NLog.LayoutRenderers
4646
/// it is recommended to use it in conjunction with the <see cref="NLog.LayoutRenderers.Wrappers.CachedLayoutRendererWrapper"/>.
4747
/// </remarks>
4848
/// <remarks>
49-
/// The entry assembly can't be found in some cases e.g. ASP.NET, unit tests, etc.
49+
/// <a href="https://github.com/NLog/NLog/wiki/AssemblyVersion-Layout-Renderer">See NLog Wiki</a>
5050
/// </remarks>
51+
/// <seealso href="https://github.com/NLog/NLog/wiki/AssemblyVersion-Layout-Renderer">Documentation on NLog Wiki</seealso>
5152
[LayoutRenderer("assembly-version")]
5253
[ThreadAgnostic]
5354
public class AssemblyVersionLayoutRenderer : LayoutRenderer

src/NLog/LayoutRenderers/ApplicationEnvironment/EnvironmentUserLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ namespace NLog.LayoutRenderers
4343
/// <summary>
4444
/// Thread identity information (username).
4545
/// </summary>
46+
/// <remarks>
47+
/// <a href="https://github.com/NLog/NLog/wiki/Environment-User-Layout-Renderer">See NLog Wiki</a>
48+
/// </remarks>
49+
/// <seealso href="https://github.com/NLog/NLog/wiki/Environment-User-Layout-Renderer">Documentation on NLog Wiki</seealso>
4650
[LayoutRenderer("environment-user")]
4751
public class EnvironmentUserLayoutRenderer : LayoutRenderer, IStringValueRenderer
4852
{

src/NLog/LayoutRenderers/ApplicationEnvironment/GarbageCollectorInfoLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// <summary>
4141
/// The information about the garbage collector.
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/Gc-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/Gc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("gc")]
4448
public class GarbageCollectorInfoLayoutRenderer : LayoutRenderer
4549
{

src/NLog/LayoutRenderers/ApplicationEnvironment/ProcessIdLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ namespace NLog.LayoutRenderers
4343
/// <summary>
4444
/// The identifier of the current process.
4545
/// </summary>
46+
/// <remarks>
47+
/// <a href="https://github.com/NLog/NLog/wiki/ProcessId-Layout-Renderer">See NLog Wiki</a>
48+
/// </remarks>
49+
/// <seealso href="https://github.com/NLog/NLog/wiki/ProcessId-Layout-Renderer">Documentation on NLog Wiki</seealso>
4650
[LayoutRenderer("processid")]
4751
[AppDomainFixedOutput]
4852
[ThreadAgnostic]

src/NLog/LayoutRenderers/ApplicationEnvironment/ProcessInfoLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ namespace NLog.LayoutRenderers
4646
/// <summary>
4747
/// The information about the running process.
4848
/// </summary>
49+
/// <remarks>
50+
/// <a href="https://github.com/NLog/NLog/wiki/ProcessInfo-Layout-Renderer">See NLog Wiki</a>
51+
/// </remarks>
52+
/// <seealso href="https://github.com/NLog/NLog/wiki/ProcessInfo-Layout-Renderer">Documentation on NLog Wiki</seealso>
4953
[LayoutRenderer("processinfo")]
5054
public class ProcessInfoLayoutRenderer : LayoutRenderer
5155
{

src/NLog/LayoutRenderers/ApplicationEnvironment/ProcessNameLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// The name of the current process.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/ProcessName-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/ProcessName-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("processname")]
4650
[AppDomainFixedOutput]
4751
[ThreadAgnostic]

src/NLog/LayoutRenderers/CallSite/CallSiteFileNameLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// The call site source file name. Full callsite <see cref="CallSiteLayoutRenderer"/>
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/Callsite-file-name-layout-renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/Callsite-file-name-layout-renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("callsite-filename")]
4549
[ThreadAgnostic]
4650
public class CallSiteFileNameLayoutRenderer : LayoutRenderer, IUsesStackTrace, IStringValueRenderer

src/NLog/LayoutRenderers/CallSite/CallSiteLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// The call site (class name, method name and source information).
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/Callsite-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/Callsite-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("callsite")]
4549
[ThreadAgnostic]
4650
public class CallSiteLayoutRenderer : LayoutRenderer, IUsesStackTrace

src/NLog/LayoutRenderers/CallSite/CallSiteLineNumberLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// <summary>
4141
/// The call site source line number. Full callsite <see cref="CallSiteLayoutRenderer"/>
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/Callsite-line-number-layout-renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/Callsite-line-number-layout-renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("callsite-linenumber")]
4448
[ThreadAgnostic]
4549
public class CallSiteLineNumberLayoutRenderer : LayoutRenderer, IUsesStackTrace, IRawValue

src/NLog/LayoutRenderers/CallSite/StackTraceLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// Stack trace renderer.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/Stack-Trace-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/Stack-Trace-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("stacktrace")]
4650
[ThreadAgnostic]
4751
public class StackTraceLayoutRenderer : LayoutRenderer, IUsesStackTrace

src/NLog/LayoutRenderers/Contexts/AllEventPropertiesLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ namespace NLog.LayoutRenderers
4343
/// <summary>
4444
/// Log event context data.
4545
/// </summary>
46+
/// <remarks>
47+
/// <a href="https://github.com/NLog/NLog/wiki/All-Event-Properties-Layout-Renderer">See NLog Wiki</a>
48+
/// </remarks>
49+
/// <seealso href="https://github.com/NLog/NLog/wiki/All-Event-Properties-Layout-Renderer">Documentation on NLog Wiki</seealso>
4650
[LayoutRenderer("all-event-properties")]
4751
[ThreadAgnostic]
4852
[ThreadAgnosticImmutable]

src/NLog/LayoutRenderers/Contexts/EventPropertiesLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// Log event context data. See <see cref="LogEventInfo.Properties"/>.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("event-properties")]
4650
[LayoutRenderer("event-property")]
4751
[LayoutRenderer("event-context")]

src/NLog/LayoutRenderers/Contexts/GdcLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// Render a Global Diagnostics Context item. See <see cref="GlobalDiagnosticsContext"/>
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/Gdc-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/Gdc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("gdc")]
4650
[ThreadAgnostic]
4751
public class GdcLayoutRenderer : LayoutRenderer, IRawValue, IStringValueRenderer

src/NLog/LayoutRenderers/Contexts/InstallContextLayoutRenderer.cs

+5-1
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,12 @@ namespace NLog.LayoutRenderers
3838
using NLog.Config;
3939

4040
/// <summary>
41-
/// Installation parameter (passed to InstallNLogConfig).
41+
/// Lookup parameter value from <see cref="InstallationContext.Parameters"/>
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/InstallContext-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/InstallContext-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("install-context")]
4448
public class InstallContextLayoutRenderer : LayoutRenderer
4549
{

src/NLog/LayoutRenderers/Contexts/MdcLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// Obsolete and replaced by <see cref="ScopeContextPropertyLayoutRenderer"/> with NLog v5.
4343
/// Render Mapped Diagnostics Logical (MDC) from <see cref="MappedDiagnosticsContext"/>
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/Mdc-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/Mdc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("mdc")]
4650
[Obsolete("Replaced by ScopeContextPropertyLayoutRenderer ${scopeproperty}. Marked obsolete on NLog 5.0")]
4751
public class MdcLayoutRenderer : LayoutRenderer, IStringValueRenderer

src/NLog/LayoutRenderers/Contexts/MdlcLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// Obsolete and replaced by <see cref="ScopeContextPropertyLayoutRenderer"/> with NLog v5.
4343
/// Render Mapped Diagnostics Logical Context (MDLC) from <see cref="MappedDiagnosticsLogicalContext"/>
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/Mdlc-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/Mdlc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("mdlc")]
4650
[Obsolete("Replaced by ScopeContextPropertyLayoutRenderer ${scopeproperty}. Marked obsolete on NLog 5.0")]
4751
public class MdlcLayoutRenderer : LayoutRenderer, IStringValueRenderer

src/NLog/LayoutRenderers/Contexts/NdcLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// Obsolete and replaced by <see cref="ScopeContextNestedStatesLayoutRenderer"/> with NLog v5.
4141
/// Render Nested Diagnostic Context (NDC) from <see cref="NestedDiagnosticsContext"/>
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/Ndc-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/Ndc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("ndc")]
4448
[Obsolete("Replaced by ScopeContextNestedStatesLayoutRenderer ${scopenested}. Marked obsolete on NLog 5.0")]
4549
public class NdcLayoutRenderer : LayoutRenderer

src/NLog/LayoutRenderers/Contexts/NdlcLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// Obsolete and replaced by <see cref="ScopeContextNestedStatesLayoutRenderer"/> with NLog v5.
4141
/// Render Nested Diagnostic Context (NDLC) from <see cref="NestedDiagnosticsLogicalContext"/>
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/Ndlc-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/Ndlc-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("ndlc")]
4448
[Obsolete("Replaced by ScopeContextNestedStatesLayoutRenderer ${scopenested}. Marked obsolete on NLog 5.0")]
4549
public class NdlcLayoutRenderer : LayoutRenderer

src/NLog/LayoutRenderers/Contexts/NdlcTimingLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// Obsolete and replaced by <see cref="ScopeContextTimingLayoutRenderer"/> with NLog v5.
4141
/// Render Nested Diagnostic Context (NDLC) timings from <see cref="NestedDiagnosticsLogicalContext"/>
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/NdlcTiming-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/NdlcTiming-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("ndlctiming")]
4448
[Obsolete("Replaced by ScopeContextTimingLayoutRenderer ${scopetiming}. Marked obsolete on NLog 5.0")]
4549
public class NdlcTimingLayoutRenderer : LayoutRenderer

src/NLog/LayoutRenderers/Contexts/ScopeContextIndentLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// <summary>
4141
/// Renders the nested states from <see cref="ScopeContext"/> like a callstack
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/ScopeIndent-Layout-Renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/ScopeIndent-Layout-Renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("scopeindent")]
4448
public sealed class ScopeContextIndentLayoutRenderer : LayoutRenderer
4549
{

src/NLog/LayoutRenderers/Contexts/ScopeContextNestedStatesLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ namespace NLog.LayoutRenderers
4343
/// <summary>
4444
/// Renders the nested states from <see cref="ScopeContext"/> like a callstack
4545
/// </summary>
46+
/// <remarks>
47+
/// <a href="https://github.com/NLog/NLog/wiki/ScopeNested-Layout-Renderer">See NLog Wiki</a>
48+
/// </remarks>
49+
/// <seealso href="https://github.com/NLog/NLog/wiki/ScopeNested-Layout-Renderer">Documentation on NLog Wiki</seealso>
4650
[LayoutRenderer("scopenested")]
4751
public sealed class ScopeContextNestedStatesLayoutRenderer : LayoutRenderer
4852
{

src/NLog/LayoutRenderers/Contexts/ScopeContextPropertyLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// Renders specified property-item from <see cref="ScopeContext"/>
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/ScopeProperty-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/ScopeProperty-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("scopeproperty")]
4549
public sealed class ScopeContextPropertyLayoutRenderer : LayoutRenderer, IStringValueRenderer
4650
{

src/NLog/LayoutRenderers/Contexts/ScopeContextTimingLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// <see cref="ScopeContext"/> Timing Renderer (Async scope)
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/ScopeTiming-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/ScopeTiming-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("scopetiming")]
4549
public sealed class ScopeContextTimingLayoutRenderer : LayoutRenderer
4650
{

src/NLog/LayoutRenderers/Contexts/TraceActivityIdLayoutRenderer.cs

+4-1
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,15 @@ namespace NLog.LayoutRenderers
3939
using System.Diagnostics;
4040
using System.Globalization;
4141
using System.Text;
42-
using NLog.Config;
4342
using NLog.Internal;
4443

4544
/// <summary>
4645
/// A renderer that puts into log a System.Diagnostics trace correlation id.
4746
/// </summary>
47+
/// <remarks>
48+
/// <a href="https://github.com/NLog/NLog/wiki/Trace-Activity-Id-Layout-Renderer">See NLog Wiki</a>
49+
/// </remarks>
50+
/// <seealso href="https://github.com/NLog/NLog/wiki/Trace-Activity-Id-Layout-Renderer">Documentation on NLog Wiki</seealso>
4851
[LayoutRenderer("activityid")]
4952
public class TraceActivityIdLayoutRenderer : LayoutRenderer, IStringValueRenderer
5053
{

src/NLog/LayoutRenderers/Counters/CounterLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ namespace NLog.LayoutRenderers
4343
/// <summary>
4444
/// A counter value (increases on each layout rendering).
4545
/// </summary>
46+
/// <remarks>
47+
/// <a href="https://github.com/NLog/NLog/wiki/Counter-Layout-Renderer">See NLog Wiki</a>
48+
/// </remarks>
49+
/// <seealso href="https://github.com/NLog/NLog/wiki/Counter-Layout-Renderer">Documentation on NLog Wiki</seealso>
4650
[LayoutRenderer("counter")]
4751
[ThreadAgnostic]
4852
public class CounterLayoutRenderer : LayoutRenderer, IRawValue

src/NLog/LayoutRenderers/Counters/GuidLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// Globally-unique identifier (GUID).
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/Guid-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/Guid-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("guid")]
4549
[ThreadAgnostic]
4650
public class GuidLayoutRenderer : LayoutRenderer, IRawValue, IStringValueRenderer

src/NLog/LayoutRenderers/Counters/SequenceIdLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ namespace NLog.LayoutRenderers
4040
/// <summary>
4141
/// The sequence ID
4242
/// </summary>
43+
/// <remarks>
44+
/// <a href="https://github.com/NLog/NLog/wiki/SequenceId-layout-renderer">See NLog Wiki</a>
45+
/// </remarks>
46+
/// <seealso href="https://github.com/NLog/NLog/wiki/SequenceId-layout-renderer">Documentation on NLog Wiki</seealso>
4347
[LayoutRenderer("sequenceid")]
4448
[ThreadAgnostic]
4549
public class SequenceIdLayoutRenderer : LayoutRenderer, IRawValue

src/NLog/LayoutRenderers/DateTime/DateLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// Current date and time.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/Date-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/Date-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("date")]
4650
[ThreadAgnostic]
4751
public class DateLayoutRenderer : LayoutRenderer, IRawValue, IStringValueRenderer

src/NLog/LayoutRenderers/DateTime/LongDateLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// The date and time in a long, sortable format yyyy-MM-dd HH:mm:ss.ffff.
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/LongDate-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/LongDate-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("longdate")]
4549
[ThreadAgnostic]
4650
public class LongDateLayoutRenderer : LayoutRenderer, IRawValue

src/NLog/LayoutRenderers/DateTime/ProcessTimeLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// The process time in format HH:mm:ss.mmm.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/ProcessTime-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/ProcessTime-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("processtime")]
4650
[ThreadAgnostic]
4751
public class ProcessTimeLayoutRenderer : LayoutRenderer, IRawValue

src/NLog/LayoutRenderers/DateTime/ShortDateLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ namespace NLog.LayoutRenderers
4242
/// <summary>
4343
/// The short date in a sortable format yyyy-MM-dd.
4444
/// </summary>
45+
/// <remarks>
46+
/// <a href="https://github.com/NLog/NLog/wiki/ShortDate-Layout-Renderer">See NLog Wiki</a>
47+
/// </remarks>
48+
/// <seealso href="https://github.com/NLog/NLog/wiki/ShortDate-Layout-Renderer">Documentation on NLog Wiki</seealso>
4549
[LayoutRenderer("shortdate")]
4650
[ThreadAgnostic]
4751
public class ShortDateLayoutRenderer : LayoutRenderer, IRawValue, IStringValueRenderer

src/NLog/LayoutRenderers/DateTime/TicksLayoutRenderer.cs

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ namespace NLog.LayoutRenderers
4141
/// <summary>
4242
/// The Ticks value of current date and time.
4343
/// </summary>
44+
/// <remarks>
45+
/// <a href="https://github.com/NLog/NLog/wiki/Ticks-Layout-Renderer">See NLog Wiki</a>
46+
/// </remarks>
47+
/// <seealso href="https://github.com/NLog/NLog/wiki/Ticks-Layout-Renderer">Documentation on NLog Wiki</seealso>
4448
[LayoutRenderer("ticks")]
4549
[ThreadAgnostic]
4650
public class TicksLayoutRenderer : LayoutRenderer, IRawValue

0 commit comments

Comments
 (0)