Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/NLog.RegEx/Conditions/RegexConditionMethods.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public static class RegexConditionMethods
/// <param name="input">The string to search for a match.</param>
/// <param name="pattern">The regular expression pattern to match.</param>
/// <param name="options">A string consisting of the desired options for the test. The possible values are those of the <see cref="RegexOptions"/> separated by commas.</param>
/// <returns>true if the regular expression finds a match; otherwise, false.</returns>
/// <returns><see langword="true"/> if the regular expression finds a match; otherwise, <see langword="false"/>.</returns>
[ConditionMethod("regex-matches")]
public static bool RegexMatches(string input, string pattern, [Optional, DefaultParameterValue("")] string options)
{
Expand Down
2 changes: 1 addition & 1 deletion src/NLog.RegEx/Internal/RegexHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public string? RegexPattern
}

/// <summary>
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <c>false</c>, the Regex Cache is used.
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <see langword="false"/>, the Regex Cache is used.
/// </summary>
public bool CompileRegex { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,19 +84,19 @@ public sealed class RegexReplaceLayoutRendererWrapper : WrapperLayoutRendererBas
/// <summary>
/// Gets or sets a value indicating whether to ignore case.
/// </summary>
/// <value>A value of <c>true</c> if case should be ignored when searching; otherwise, <c>false</c>.</value>
/// <value>A value of <see langword="true"/> if case should be ignored when searching; otherwise, <see langword="false"/>.</value>
/// <docgen category='Condition Options' order='10' />
public bool IgnoreCase { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to search for whole words.
/// </summary>
/// <value>A value of <c>true</c> if whole words should be searched for; otherwise, <c>false</c>.</value>
/// <value>A value of <see langword="true"/> if whole words should be searched for; otherwise, <see langword="false"/>.</value>
/// <docgen category='Condition Options' order='10' />
public bool WholeWords { get; set; }

/// <summary>
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <c>false</c>, the Regex Cache is used.
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <see langword="false"/>, the Regex Cache is used.
/// </summary>
/// <docgen category='Condition Options' order='10' />
public bool CompileRegex { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/NLog.RegEx/Targets/ConsoleWordHighlightingRuleRegex.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public string? Regex
}

/// <summary>
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <c>false</c>, the Regex Cache is used.
/// Compile the <see cref="Regex"/>? This can improve the performance, but at the costs of more memory usage. If <see langword="false"/>, the Regex Cache is used.
/// </summary>
/// <docgen category='Highlighting Rules' order='10' />
public bool CompileRegex
Expand Down
16 changes: 8 additions & 8 deletions src/NLog.Targets.ConcurrentFile/ConcurrentFileTarget.cs
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ private FilePathLayout CreateFileNameLayout(Layout value)

/// <summary>
/// Cleanup invalid values in a filename, e.g. slashes in a filename. If set to <c>true</c>, this can impact the performance of massive writes.
/// If set to <c>false</c>, nothing gets written when the filename is wrong.
/// If set to <see langword="false"/>, nothing gets written when the filename is wrong.
/// </summary>
/// <docgen category='Output Options' order='100' />
public bool CleanupFileName
Expand Down Expand Up @@ -247,7 +247,7 @@ public FilePathKind FileNameKind
/// Gets or sets a value indicating whether to create directories if they do not exist.
/// </summary>
/// <remarks>
/// Setting this to false may improve performance a bit, but you'll receive an error
/// Setting this to <see langword="false"/> may improve performance a bit, but you'll receive an error
/// when attempting to write to a directory that's not present.
/// </remarks>
/// <docgen category='Output Options' order='50' />
Expand All @@ -272,8 +272,8 @@ public FilePathKind FileNameKind
/// Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event.
/// </summary>
/// <remarks>
/// KeepFileOpen = true gives the best performance, and ensure the file-lock is not lost to other applications.<br/>
/// KeepFileOpen = false gives the best compability, but slow performance and lead to file-locking issues with other applications.
/// KeepFileOpen = <see langword="true"/> gives the best performance, and ensure the file-lock is not lost to other applications.<br/>
/// KeepFileOpen = <see langword="false"/> gives the best compatibility, but slow performance and lead to file-locking issues with other applications.
/// </remarks>
/// <docgen category='Performance Tuning Options' order='10' />
public bool KeepFileOpen
Expand Down Expand Up @@ -410,7 +410,7 @@ public bool ConcurrentWrites
}

/// <summary>
/// Obsolete and replaced by <see cref="KeepFileOpen"/> = <c>false</c> with NLog v5.3.
/// Obsolete and replaced by <see cref="KeepFileOpen"/> = <see langword="false"/> with NLog v5.3.
/// Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on different network hosts.
/// </summary>
/// <remarks>
Expand All @@ -424,7 +424,7 @@ public bool ConcurrentWrites
/// <summary>
/// Gets or sets a value indicating whether to write BOM (byte order mark) in created files.
///
/// Defaults to true for UTF-16 and UTF-32
/// Defaults to <see langword="true"/> for UTF-16 and UTF-32
/// </summary>
/// <docgen category='Output Options' order='50' />
public bool WriteBom
Expand Down Expand Up @@ -490,7 +490,7 @@ public bool ArchiveOldFileOnStartup
/// Gets or sets a value of the file size threshold to archive old log file on startup.
/// </summary>
/// <remarks>
/// This option won't work if <see cref="ArchiveOldFileOnStartup"/> is set to <c>false</c>
/// This option won't work if <see cref="ArchiveOldFileOnStartup"/> is set to <see langword="false"/>
/// Default value is 0 which means that the file is archived as soon as archival on
/// startup is enabled.
/// </remarks>
Expand Down Expand Up @@ -1725,7 +1725,7 @@ private string GetArchiveFileNamePattern(string fileName, LogEventInfo eventInfo
/// <param name="upcomingWriteSize">The size in bytes of the next chunk of data to be written in the file.</param>
/// <param name="previousLogEventTimestamp">The DateTime of the previous log event for this file.</param>
/// <param name="initializedNewFile">File has just been opened.</param>
/// <returns>True when archive operation of the file was completed (by this target or a concurrent target)</returns>
/// <returns><see langword="true"/> when archive operation of the file was completed (by this target or a concurrent target)</returns>
private bool TryArchiveFile(string fileName, LogEventInfo ev, int upcomingWriteSize, DateTime previousLogEventTimestamp, bool initializedNewFile)
{
if (!IsArchivingEnabled)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public void Dispose()
/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
/// <param name="disposing">True to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
/// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
protected virtual void Dispose(bool disposing)
{
if (disposing)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ internal interface ICreateFileParameters
/// Gets or sets a value indicating whether to create directories if they do not exist.
/// </summary>
/// <remarks>
/// Setting this to false may improve performance a bit, but you'll receive an error
/// Setting this to <see langword="false"/> may improve performance a bit, but you'll receive an error
/// when attempting to write to a directory that's not present.
/// </remarks>
bool CreateDirs { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ protected FileArchiveModeBase(bool isArchiveCleanupEnabled)
/// <param name="archiveFilePath">Base archive file pattern</param>
/// <param name="maxArchiveFiles">Maximum number of archive files that should be kept</param>
/// <param name="maxArchiveDays">Maximum days of archive files that should be kept</param>
/// <returns>True, when archive cleanup is needed</returns>
/// <returns><see langword="true"/>, when archive cleanup is needed</returns>
public virtual bool AttemptCleanupOnInitializeFile(string archiveFilePath, int maxArchiveFiles, int maxArchiveDays)
{
if (maxArchiveFiles > 0 && _lastArchiveFileCount++ > maxArchiveFiles)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ interface IFileArchiveMode
/// <param name="archiveFilePath">Base archive file pattern</param>
/// <param name="maxArchiveFiles">Maximum number of archive files that should be kept</param>
/// <param name="maxArchiveDays">Maximum days of archive files that should be kept</param>
/// <returns>True, when archive cleanup is needed</returns>
/// <returns><see langword="true"/>, when archive cleanup is needed</returns>
bool AttemptCleanupOnInitializeFile(string archiveFilePath, int maxArchiveFiles, int maxArchiveDays);

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/NLog.Targets.ConcurrentFile/Internal/StringHelpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ internal static bool IsNullOrWhiteSpace(string value)
/// <summary>
/// Compares the contents of a StringBuilder and a String
/// </summary>
/// <returns>True when content is the same</returns>
/// <returns><see langword="true"/> when content is the same</returns>
public static bool EqualTo(this StringBuilder builder, string other)
{
if (builder.Length != other.Length)
Expand Down
4 changes: 2 additions & 2 deletions src/NLog.Targets.Mail/MailTarget.cs
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ public Layout From
/// <summary>
/// Gets or sets a value indicating whether to add new lines between log entries.
/// </summary>
/// <value>A value of <c>true</c> if new lines should be added; otherwise, <c>false</c>.</value>
/// <value>A value of <see langword="true"/> if new lines should be added; otherwise, <see langword="false"/>.</value>
/// <docgen category='Message Options' order='99' />
public bool AddNewLines { get; set; }

Expand Down Expand Up @@ -292,7 +292,7 @@ public Layout Body
/// <summary>
/// Gets or sets a value indicating whether NewLine characters in the body should be replaced with <br/> tags.
/// </summary>
/// <remarks>Only happens when <see cref="Html"/> is set to true.</remarks>
/// <remarks>Only happens when <see cref="Html"/> is set to <see langword="true"/>.</remarks>
/// <docgen category='Message Options' order='100' />
public bool ReplaceNewlineWithBrTagInHtml { get; set; }

Expand Down
4 changes: 2 additions & 2 deletions src/NLog.Targets.Network/Layouts/GelfLayout.cs
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public Layout GelfFacility
public bool ExcludeEmptyProperties { get; set; }

/// <summary>
/// List of property names to exclude when <see cref="IncludeEventProperties"/> is true
/// List of property names to exclude when <see cref="IncludeEventProperties"/> is <see langword="true"/>
/// </summary>
#if NET35
public HashSet<string> ExcludeProperties { get; set; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
Expand All @@ -111,7 +111,7 @@ public Layout GelfFacility
#endif

/// <summary>
/// List of property names to include when <see cref="IncludeEventProperties"/> is true
/// List of property names to include when <see cref="IncludeEventProperties"/> is <see langword="true"/>
/// </summary>
#if NET35
public HashSet<string> IncludeProperties { get; set; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
Expand Down
8 changes: 4 additions & 4 deletions src/NLog.Targets.Network/Layouts/SyslogLayout.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public class SyslogLayout : CompoundLayout
public bool Rfc5424 { get; set; }

/// <summary>
/// Gets or sets a value indicating what DateTime format should be used when <see cref="Rfc5424"/> = true
/// Gets or sets a value indicating what DateTime format should be used when <see cref="Rfc5424"/> = <see langword="true"/>
/// </summary>
public Layout SyslogTimestamp { get; set; } = "${date:format=o}";

Expand Down Expand Up @@ -126,17 +126,17 @@ public Layout SyslogProcessId
public SyslogFacility SyslogFacility { get; set; } = SyslogFacility.User;

/// <summary>
/// Gets or sets the prefix for StructuredData when <see cref="Rfc5424"/> = true
/// Gets or sets the prefix for StructuredData when <see cref="Rfc5424"/> = <see langword="true"/>
/// </summary>
public Layout StructuredDataId { get; set; } = "meta";

/// <summary>
/// Gets or sets a value indicating whether LogEvent Properties should be included for StructuredData when <see cref="Rfc5424"/> = true
/// Gets or sets a value indicating whether LogEvent Properties should be included for StructuredData when <see cref="Rfc5424"/> = <see langword="true"/>
/// </summary>
public bool IncludeEventProperties { get; set; }

/// <summary>
/// List of StructuredData Parameters to include when <see cref="Rfc5424"/> = true
/// List of StructuredData Parameters to include when <see cref="Rfc5424"/> = <see langword="true"/>
/// </summary>
[ArrayParameter(typeof(TargetPropertyWithContext), "StructuredDataParam")]
public List<TargetPropertyWithContext> StructuredDataParams { get; } = new List<TargetPropertyWithContext>();
Expand Down
7 changes: 4 additions & 3 deletions src/NLog.Targets.Network/Targets/NetworkTarget.cs
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public LineEndingMode LineEnding
public NetworkTargetConnectionsOverflowAction OnConnectionOverflow { get; set; } = NetworkTargetConnectionsOverflowAction.Discard;

/// <summary>
/// Gets or sets the maximum queue size for a single connection. Requires <see cref="KeepConnection"/> = true
/// Gets or sets the maximum queue size for a single connection. Requires <see cref="KeepConnection"/> = <see langword="true"/>
/// </summary>
/// <remarks>
/// When having reached the maximum limit, then <see cref="OnQueueOverflow"/> action will apply.
Expand All @@ -196,7 +196,7 @@ public LineEndingMode LineEnding
public event EventHandler<NetworkLogEventDroppedEventArgs>? LogEventDropped;

/// <summary>
/// Gets or sets the size of the connection cache (number of connections which are kept alive). Requires <see cref="KeepConnection"/> = true
/// Gets or sets the size of the connection cache (number of connections which are kept alive). Requires <see cref="KeepConnection"/> = <see langword="true"/>
/// </summary>
/// <docgen category="Connection Options" order="10"/>
public int ConnectionCacheSize { get; set; } = 5;
Expand Down Expand Up @@ -252,8 +252,9 @@ public LineEndingMode LineEnding
public int SendTimeoutSeconds { get; set; } = 100;

/// <summary>
/// Gets or sets whether to disable the delayed ACK timer, and avoid delay of 200 ms. Default = true.
/// Gets or sets whether to disable the delayed ACK timer, and avoid delay of 200 ms.
/// </summary>
/// <remarks>Default: <see langword="true"/></remarks>
public bool NoDelay { get; set; } = true;

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions src/NLog.Targets.Trace/NLogTraceListener.cs
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ public bool DisableFlush
/// Gets a value indicating whether the trace listener is thread safe.
/// </summary>
/// <value></value>
/// <returns>true if the trace listener is thread safe; otherwise, false. The default is false.</returns>
/// <returns><see langword="true"/> if the trace listener is thread safe; otherwise, false. The default is <see langword="false"/>.</returns>
public override bool IsThreadSafe => true;

/// <summary>
Expand Down Expand Up @@ -251,7 +251,7 @@ public override void Fail(string message, string detailMessage)
}

/// <summary>
/// Flushes the output (if <see cref="DisableFlush"/> is not <c>true</c>) buffer with the default timeout of 15 seconds.
/// Flushes the output (if <see cref="DisableFlush"/> is not <see langword="true"/>) buffer with the default timeout of 15 seconds.
/// </summary>
public override void Flush()
{
Expand Down
4 changes: 2 additions & 2 deletions src/NLog.Targets.WebService/WebServiceTarget.cs
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,15 @@ public WebServiceProxyType ProxyType
/// <summary>
/// Gets or sets a value whether escaping be done according to Rfc3986 (Supports Internationalized Resource Identifiers - IRIs)
/// </summary>
/// <value>A value of <c>true</c> if Rfc3986; otherwise, <c>false</c> for legacy Rfc2396.</value>
/// <value>A value of <see langword="true"/> if Rfc3986; otherwise, <see langword="false"/> for legacy Rfc2396.</value>
/// <docgen category='Web Service Options' order='100' />
[Obsolete("Replaced by WebUtility.UrlEncode. Marked obsolete with NLog 6.0")]
public bool EscapeDataRfc3986 { get; set; }

/// <summary>
/// Gets or sets a value whether escaping be done according to the old NLog style (Very non-standard)
/// </summary>
/// <value>A value of <c>true</c> if legacy encoding; otherwise, <c>false</c> for standard UTF8 encoding.</value>
/// <value>A value of <see langword="true"/> if legacy encoding; otherwise, <see langword="false"/> for standard UTF8 encoding.</value>
/// <docgen category='Web Service Options' order='100' />
[Obsolete("Replaced by WebUtility.UrlEncode. Marked obsolete with NLog 6.0")]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion src/NLog.WindowsRegistry/RegistryLayoutRenderer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public class RegistryLayoutRenderer : LayoutRenderer
/// <summary>
/// Require escaping backward slashes in <see cref="DefaultValue"/>. Need to be backwards-compatible.
///
/// When true:
/// When <see langword="true"/>:
///
/// `\` in value should be configured as `\\`
/// `\\` in value should be configured as `\\\\`.
Expand Down
2 changes: 1 addition & 1 deletion src/NLog/Common/AsyncHelpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ public static AsyncContinuation PreventMultipleCalls(AsyncContinuation asyncCont

var sb = new StringBuilder();
string separator = string.Empty;
string newline = EnvironmentHelper.NewLine;
string newline = Environment.NewLine;
foreach (var ex in exceptions)
{
sb.Append(separator);
Expand Down
Loading