From 110cdd8215fcda647ac4113d7401f9cbfd59fe0f Mon Sep 17 00:00:00 2001 From: Battlefield Duck Date: Mon, 29 Jan 2024 10:20:59 +0800 Subject: [PATCH] warning disable CS1587 --- XtermBlazor/TerminalOptions.cs | 20 ++++++++++++++------ XtermBlazor/XtermBlazor.csproj | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/XtermBlazor/TerminalOptions.cs b/XtermBlazor/TerminalOptions.cs index 4df519c..07515c8 100644 --- a/XtermBlazor/TerminalOptions.cs +++ b/XtermBlazor/TerminalOptions.cs @@ -20,7 +20,7 @@ public class TerminalOptions /// /// Whether background should support non-opaque color. It must be set before /// executing the `Terminal.open()` method and can't be changed later without - /// executing it again. Note that enabling this can negatively impact + /// executing it again. Note that enabling this can negatively impact /// performance. /// [JsonPropertyName("allowTransparency")] @@ -171,10 +171,11 @@ public class TerminalOptions [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] public int? LineHeight { get; set; } +#pragma warning disable CS1587 // XML comment is not placed on a valid language element /// /// The handler for OSC 8 hyperlinks. Links will use the `confirm` browser /// API with a strongly worded warning if no link handler is set. - /// + /// /// When setting this, consider the security of users opening these links, /// at a minimum there should be a tooltip or a prompt when hovering or /// activating the link respectively.An example of what might be possible is @@ -185,6 +186,7 @@ public class TerminalOptions // [JsonPropertyName("linkHandler")] // [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] // public LinkHandler? LinkHandler { get; set; } +#pragma warning restore CS1587 // XML comment is not placed on a valid language element /// /// What log level to use. The default is 'info' @@ -193,12 +195,14 @@ public class TerminalOptions [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] public LogLevel? LogLevel { get; set; } +#pragma warning disable CS1587 // XML comment is not placed on a valid language element /// /// A logger to use instead of `console`. /// // [JsonPropertyName("logger")] // [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] // public Logger Logger { get; set; } = new(); +#pragma warning restore CS1587 // XML comment is not placed on a valid language element /// /// Whether to treat option as the meta key. @@ -311,15 +315,15 @@ public class TerminalOptions /// conpty operate by doing line wrapping on their side, xterm.js does not /// have access to wrapped lines.When Windows mode is enabled the following /// changes will be in effect: - /// + /// /// - Reflow is disabled. /// - Lines are assumed to be wrapped if the last character of the line is /// not whitespace. - /// + /// /// When using conpty on Windows 11 version >= 21376, it is recommended to /// disable this because native text wrapping sequences are output correctly /// thanks to https://github.com/microsoft/terminal/issues/405 - /// + /// /// @deprecated Use {@link windowsPty}. This value will be ignored if /// windowsPty is set. /// @@ -331,7 +335,7 @@ public class TerminalOptions /// Compatibility information when the pty is known to be hosted on Windows. /// Setting this will turn on certain heuristics/workarounds depending on the /// values: - /// + /// /// - `if (backend !== undefined || buildNumber !== undefined)` /// - When increasing the rows in the terminal, the amount increased into /// the scrollback. This is done because ConPTY does not behave like @@ -355,6 +359,8 @@ public class TerminalOptions [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] public string? WordSeparator { get; set; } + +#pragma warning disable CS1587 // XML comment is not placed on a valid language element /// /// Enable various window manipulation and report features. /// All features are disabled by default for security reasons. @@ -362,12 +368,14 @@ public class TerminalOptions //[JsonPropertyName("windowOptions")] //[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] //public WindowOptions? WindowOptions { get; set; } +#pragma warning restore CS1587 // XML comment is not placed on a valid language element /// /// The width, in pixels, of the canvas for the overview ruler. The overview /// ruler will be hidden when not set. /// [JsonPropertyName("overviewRulerWidth")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] public int? OverviewRulerWidth { get; set; } } diff --git a/XtermBlazor/XtermBlazor.csproj b/XtermBlazor/XtermBlazor.csproj index a51f3a7..8f0f16a 100644 --- a/XtermBlazor/XtermBlazor.csproj +++ b/XtermBlazor/XtermBlazor.csproj @@ -17,7 +17,7 @@ LICENSE Brings xterm.js to Blazor icon.png - 1.10.0 + 1.10.1 xterm, xterm-js, blazor, blazor-server, blazor-webassembly, blazor-wasm, xtermblazor true true