Skip to content

Commit

Permalink
warning disable CS1587
Browse files Browse the repository at this point in the history
  • Loading branch information
BattlefieldDuck committed Jan 29, 2024
1 parent 16cd9d7 commit 110cdd8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
20 changes: 14 additions & 6 deletions XtermBlazor/TerminalOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class TerminalOptions
/// <summary>
/// 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.
/// </summary>
[JsonPropertyName("allowTransparency")]
Expand Down Expand Up @@ -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
/// <summary>
/// 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
Expand All @@ -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

/// <summary>
/// What log level to use. The default is 'info'
Expand All @@ -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
/// <summary>
/// A logger to use instead of `console`.
/// </summary>
// [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

/// <summary>
/// Whether to treat option as the meta key.
Expand Down Expand Up @@ -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.
/// </summary>
Expand All @@ -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
Expand All @@ -355,19 +359,23 @@ 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
/// <summary>
/// Enable various window manipulation and report features.
/// All features are disabled by default for security reasons.
/// </summary>
//[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

/// <summary>
/// The width, in pixels, of the canvas for the overview ruler. The overview
/// ruler will be hidden when not set.
/// </summary>
[JsonPropertyName("overviewRulerWidth")]

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? OverviewRulerWidth { get; set; }
}
Expand Down
2 changes: 1 addition & 1 deletion XtermBlazor/XtermBlazor.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<PackageLicenseFile>LICENSE</PackageLicenseFile>
<Description>Brings xterm.js to Blazor</Description>
<PackageIcon>icon.png</PackageIcon>
<Version>1.10.0</Version>
<Version>1.10.1</Version>
<PackageTags>xterm, xterm-js, blazor, blazor-server, blazor-webassembly, blazor-wasm, xtermblazor</PackageTags>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
Expand Down

0 comments on commit 110cdd8

Please sign in to comment.