Skip to content

Commit 13f5882

Browse files
snakefootsnakefoot
committed
Handle code-review comments
1 parent f9a490b commit 13f5882

File tree

74 files changed

+229
-257
lines changed

Some content is hidden

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

74 files changed

+229
-257
lines changed

‎src/NLog.RegEx/Conditions/RegexConditionMethods.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class RegexConditionMethods
1717
/// <param name="input">The string to search for a match.</param>
1818
/// <param name="pattern">The regular expression pattern to match.</param>
1919
/// <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>
20-
/// <returns>true if the regular expression finds a match; otherwise, false.</returns>
20+
/// <returns><see langword="true"/> if the regular expression finds a match; otherwise, <see langword="false"/>.</returns>
2121
[ConditionMethod("regex-matches")]
2222
public static bool RegexMatches(string input, string pattern, [Optional, DefaultParameterValue("")] string options)
2323
{

‎src/NLog.RegEx/Internal/RegexHelper.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public string? RegexPattern
6767
}
6868

6969
/// <summary>
70-
/// 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.
70+
/// 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.
7171
/// </summary>
7272
public bool CompileRegex { get; set; }
7373

‎src/NLog.RegEx/LayoutRenderers/Wrappers/RegexReplaceLayoutRendererWrapper.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,19 +84,19 @@ public sealed class RegexReplaceLayoutRendererWrapper : WrapperLayoutRendererBas
8484
/// <summary>
8585
/// Gets or sets a value indicating whether to ignore case.
8686
/// </summary>
87-
/// <value>A value of <c>true</c> if case should be ignored when searching; otherwise, <c>false</c>.</value>
87+
/// <value>A value of <see langword="true"/> if case should be ignored when searching; otherwise, <see langword="false"/>.</value>
8888
/// <docgen category='Condition Options' order='10' />
8989
public bool IgnoreCase { get; set; }
9090

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

9898
/// <summary>
99-
/// 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.
99+
/// 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.
100100
/// </summary>
101101
/// <docgen category='Condition Options' order='10' />
102102
public bool CompileRegex { get; set; }

‎src/NLog.RegEx/Targets/ConsoleWordHighlightingRuleRegex.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public string? Regex
5656
}
5757

5858
/// <summary>
59-
/// 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.
59+
/// 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.
6060
/// </summary>
6161
/// <docgen category='Highlighting Rules' order='10' />
6262
public bool CompileRegex

‎src/NLog.Targets.ConcurrentFile/ConcurrentFileTarget.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ private FilePathLayout CreateFileNameLayout(Layout value)
206206

207207
/// <summary>
208208
/// 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.
209-
/// If set to <c>false</c>, nothing gets written when the filename is wrong.
209+
/// If set to <see langword="false"/>, nothing gets written when the filename is wrong.
210210
/// </summary>
211211
/// <docgen category='Output Options' order='100' />
212212
public bool CleanupFileName
@@ -247,7 +247,7 @@ public FilePathKind FileNameKind
247247
/// Gets or sets a value indicating whether to create directories if they do not exist.
248248
/// </summary>
249249
/// <remarks>
250-
/// Setting this to false may improve performance a bit, but you'll receive an error
250+
/// Setting this to <see langword="false"/> may improve performance a bit, but you'll receive an error
251251
/// when attempting to write to a directory that's not present.
252252
/// </remarks>
253253
/// <docgen category='Output Options' order='50' />
@@ -272,8 +272,8 @@ public FilePathKind FileNameKind
272272
/// Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event.
273273
/// </summary>
274274
/// <remarks>
275-
/// KeepFileOpen = true gives the best performance, and ensure the file-lock is not lost to other applications.<br/>
276-
/// KeepFileOpen = false gives the best compability, but slow performance and lead to file-locking issues with other applications.
275+
/// KeepFileOpen = <see langword="true"/> gives the best performance, and ensure the file-lock is not lost to other applications.<br/>
276+
/// KeepFileOpen = <see langword="false"/> gives the best compatibility, but slow performance and lead to file-locking issues with other applications.
277277
/// </remarks>
278278
/// <docgen category='Performance Tuning Options' order='10' />
279279
public bool KeepFileOpen
@@ -410,7 +410,7 @@ public bool ConcurrentWrites
410410
}
411411

412412
/// <summary>
413-
/// Obsolete and replaced by <see cref="KeepFileOpen"/> = <c>false</c> with NLog v5.3.
413+
/// Obsolete and replaced by <see cref="KeepFileOpen"/> = <see langword="false"/> with NLog v5.3.
414414
/// Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on different network hosts.
415415
/// </summary>
416416
/// <remarks>
@@ -424,7 +424,7 @@ public bool ConcurrentWrites
424424
/// <summary>
425425
/// Gets or sets a value indicating whether to write BOM (byte order mark) in created files.
426426
///
427-
/// Defaults to true for UTF-16 and UTF-32
427+
/// Defaults to <see langword="true"/> for UTF-16 and UTF-32
428428
/// </summary>
429429
/// <docgen category='Output Options' order='50' />
430430
public bool WriteBom
@@ -490,7 +490,7 @@ public bool ArchiveOldFileOnStartup
490490
/// Gets or sets a value of the file size threshold to archive old log file on startup.
491491
/// </summary>
492492
/// <remarks>
493-
/// This option won't work if <see cref="ArchiveOldFileOnStartup"/> is set to <c>false</c>
493+
/// This option won't work if <see cref="ArchiveOldFileOnStartup"/> is set to <see langword="false"/>
494494
/// Default value is 0 which means that the file is archived as soon as archival on
495495
/// startup is enabled.
496496
/// </remarks>
@@ -1725,7 +1725,7 @@ private string GetArchiveFileNamePattern(string fileName, LogEventInfo eventInfo
17251725
/// <param name="upcomingWriteSize">The size in bytes of the next chunk of data to be written in the file.</param>
17261726
/// <param name="previousLogEventTimestamp">The DateTime of the previous log event for this file.</param>
17271727
/// <param name="initializedNewFile">File has just been opened.</param>
1728-
/// <returns>True when archive operation of the file was completed (by this target or a concurrent target)</returns>
1728+
/// <returns><see langword="true"/> when archive operation of the file was completed (by this target or a concurrent target)</returns>
17291729
private bool TryArchiveFile(string fileName, LogEventInfo ev, int upcomingWriteSize, DateTime previousLogEventTimestamp, bool initializedNewFile)
17301730
{
17311731
if (!IsArchivingEnabled)

‎src/NLog.Targets.ConcurrentFile/FileAppenders/BaseFileAppender.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ public void Dispose()
156156
/// <summary>
157157
/// Releases unmanaged and - optionally - managed resources.
158158
/// </summary>
159-
/// <param name="disposing">True to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
159+
/// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
160160
protected virtual void Dispose(bool disposing)
161161
{
162162
if (disposing)

‎src/NLog.Targets.ConcurrentFile/FileAppenders/ICreateFileParameters.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ internal interface ICreateFileParameters
6464
/// Gets or sets a value indicating whether to create directories if they do not exist.
6565
/// </summary>
6666
/// <remarks>
67-
/// Setting this to false may improve performance a bit, but you'll receive an error
67+
/// Setting this to <see langword="false"/> may improve performance a bit, but you'll receive an error
6868
/// when attempting to write to a directory that's not present.
6969
/// </remarks>
7070
bool CreateDirs { get; }

‎src/NLog.Targets.ConcurrentFile/FileArchiveModes/FileArchiveModeBase.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ protected FileArchiveModeBase(bool isArchiveCleanupEnabled)
6060
/// <param name="archiveFilePath">Base archive file pattern</param>
6161
/// <param name="maxArchiveFiles">Maximum number of archive files that should be kept</param>
6262
/// <param name="maxArchiveDays">Maximum days of archive files that should be kept</param>
63-
/// <returns>True, when archive cleanup is needed</returns>
63+
/// <returns><see langword="true"/>, when archive cleanup is needed</returns>
6464
public virtual bool AttemptCleanupOnInitializeFile(string archiveFilePath, int maxArchiveFiles, int maxArchiveDays)
6565
{
6666
if (maxArchiveFiles > 0 && _lastArchiveFileCount++ > maxArchiveFiles)

‎src/NLog.Targets.ConcurrentFile/FileArchiveModes/IFileArchiveMode.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ interface IFileArchiveMode
4646
/// <param name="archiveFilePath">Base archive file pattern</param>
4747
/// <param name="maxArchiveFiles">Maximum number of archive files that should be kept</param>
4848
/// <param name="maxArchiveDays">Maximum days of archive files that should be kept</param>
49-
/// <returns>True, when archive cleanup is needed</returns>
49+
/// <returns><see langword="true"/>, when archive cleanup is needed</returns>
5050
bool AttemptCleanupOnInitializeFile(string archiveFilePath, int maxArchiveFiles, int maxArchiveDays);
5151

5252
/// <summary>

‎src/NLog.Targets.ConcurrentFile/Internal/StringHelpers.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ internal static bool IsNullOrWhiteSpace(string value)
5454
/// <summary>
5555
/// Compares the contents of a StringBuilder and a String
5656
/// </summary>
57-
/// <returns>True when content is the same</returns>
57+
/// <returns><see langword="true"/> when content is the same</returns>
5858
public static bool EqualTo(this StringBuilder builder, string other)
5959
{
6060
if (builder.Length != other.Length)

0 commit comments

Comments
 (0)