Skip to content

Commit 9b1453c

Browse files
committed
Simplify XML docs for maxLogLines parameter
Removed specific value range details from the XML documentation for the maxLogLines parameter in both RichTextBoxSinkLoggerConfigurationExtensions and RichTextBoxSinkOptions. This makes the documentation less restrictive and easier to maintain.
1 parent 0fc797d commit 9b1453c

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

Serilog.Sinks.RichTextBox.WinForms.Colored/RichTextBoxSinkLoggerConfigurationExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public static class RichTextBoxSinkLoggerConfigurationExtensions
3939
/// <param name="richTextBoxControl">The target <see cref="RichTextBox"/> instance that will display the log output.</param>
4040
/// <param name="theme">Optional theme controlling colours of individual message tokens. When <c>null</c>, <see cref="Serilog.Sinks.RichTextBoxForms.Themes.ThemePresets.Literate"/> is used.</param>
4141
/// <param name="autoScroll">When <c>true</c> (default) the control automatically scrolls to the newest log entry.</param>
42-
/// <param name="maxLogLines">Maximum number of log events retained in the circular buffer and rendered in the control. Must be between 1 and 1,024 (default: 256).</param>
42+
/// <param name="maxLogLines">Maximum number of log events retained in the circular buffer and rendered in the control.</param>
4343
/// <param name="outputTemplate">Message template that controls the textual representation of each log event.</param>
4444
/// <param name="formatProvider">Culture-specific or custom formatting provider, or <c>null</c> to use the invariant culture.</param>
4545
/// <param name="minimumLogEventLevel">Minimum level below which events are ignored by this sink.</param>

Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/RichTextBoxSinkOptions.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ public class RichTextBoxSinkOptions
3232
/// </summary>
3333
/// <param name="theme">The colour theme applied when rendering individual message tokens.</param>
3434
/// <param name="autoScroll">When <c>true</c> (default) the target control scrolls automatically to the most recent log line.</param>
35-
/// <param name="maxLogLines">Maximum number of log events retained in the in-memory circular buffer and rendered in the control. Must be between 1 and 2048 (default: 256).</param>
36-
/// <param name="flushInterval">Timeout, in milliseconds, after which buffered events are flushed to the control if a batch has not yet been triggered. Must be between 250ms and 30 seconds (default: 500ms).</param>
35+
/// <param name="maxLogLines">Maximum number of log events retained in the in-memory circular buffer and rendered in the control.</param>
3736
/// <param name="outputTemplate">Serilog output template that controls textual formatting of each log event.</param>
3837
/// <param name="formatProvider">Optional culture-specific or custom formatting provider used when rendering scalar values; <c>null</c> for the invariant culture.</param>
3938
public RichTextBoxSinkOptions(

0 commit comments

Comments
 (0)