From 565094abbe921a76abb963291f3512d02c04067d Mon Sep 17 00:00:00 2001 From: Clint Rutkas Date: Wed, 1 Apr 2026 09:46:25 -0700 Subject: [PATCH] Fix SA1623: Fix property documentation summaries (#46717) Update 29 property XML doc summaries to begin with Gets, Gets or sets, or Gets a value indicating whether as required by StyleCop SA1623. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Helpers/InterlockedBoolean.cs | 2 +- .../Text/PinyinFuzzyMatcherOptions.cs | 2 +- .../AppearanceSettingsViewModel.cs | 8 ++++---- .../BackdropStyleConfig.cs | 6 +++--- .../Services/ThemeSnapshot.cs | 2 +- .../Settings/DockSettings.cs | 6 +++--- .../WindowPosition.cs | 14 +++++++------- .../Events/CmdPalDockConfiguration.cs | 2 +- .../Events/CmdPalExtensionInvoked.cs | 2 +- .../Microsoft.CmdPal.Ext.Apps/AllAppsSettings.cs | 2 +- .../ShellHelpers.cs | 2 +- .../PowerDisplay.Lib/Utils/VcpNames.cs | 2 +- .../Settings.UI.Library/PowerDisplayProperties.cs | 4 ++-- .../ViewModels/PowerDisplayViewModel.cs | 4 ++-- 14 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/modules/cmdpal/Microsoft.CmdPal.Common/Helpers/InterlockedBoolean.cs b/src/modules/cmdpal/Microsoft.CmdPal.Common/Helpers/InterlockedBoolean.cs index 4cec20ad91..df9362856f 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.Common/Helpers/InterlockedBoolean.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.Common/Helpers/InterlockedBoolean.cs @@ -12,7 +12,7 @@ public struct InterlockedBoolean(bool initialValue = false) private int _value = initialValue ? 1 : 0; /// - /// Gets or sets the boolean value atomically + /// Gets or sets a value indicating whether the atomic boolean is true. /// public bool Value { diff --git a/src/modules/cmdpal/Microsoft.CmdPal.Common/Text/PinyinFuzzyMatcherOptions.cs b/src/modules/cmdpal/Microsoft.CmdPal.Common/Text/PinyinFuzzyMatcherOptions.cs index 9360c2e9af..4a0fd2ddf6 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.Common/Text/PinyinFuzzyMatcherOptions.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.Common/Text/PinyinFuzzyMatcherOptions.cs @@ -8,6 +8,6 @@ public sealed class PinyinFuzzyMatcherOptions { public PinyinMode Mode { get; init; } = PinyinMode.AutoSimplifiedChineseUi; - /// Remove IME syllable separators (') for query secondary variant. + /// Gets a value indicating whether IME syllable separators (') are removed for query secondary variant. public bool RemoveApostrophesForQuery { get; init; } = true; } diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/AppearanceSettingsViewModel.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/AppearanceSettingsViewModel.cs index 180c7e2cdc..27db7185ab 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/AppearanceSettingsViewModel.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/AppearanceSettingsViewModel.cs @@ -341,25 +341,25 @@ public sealed partial class AppearanceSettingsViewModel : ObservableObject, IDis } /// - /// Gets whether the backdrop opacity slider should be visible. + /// Gets a value indicating whether the backdrop opacity slider should be visible. /// public bool IsBackdropOpacityVisible => BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity; /// - /// Gets whether the backdrop description (for styles without options) should be visible. + /// Gets a value indicating whether the backdrop description (for styles without options) should be visible. /// public bool IsMicaBackdropDescriptionVisible => !BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity; /// - /// Gets whether background/colorization settings are available. + /// Gets a value indicating whether background/colorization settings are available. /// public bool IsBackgroundSettingsEnabled => BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization; /// - /// Gets whether the "not available" message should be shown (inverse of IsBackgroundSettingsEnabled). + /// Gets a value indicating whether the "not available" message should be shown (inverse of IsBackgroundSettingsEnabled). /// public bool IsBackgroundNotAvailableVisible => !BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization; diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/BackdropStyleConfig.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/BackdropStyleConfig.cs index c9fa50a23d..9e0dee2e38 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/BackdropStyleConfig.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/BackdropStyleConfig.cs @@ -36,17 +36,17 @@ public sealed record BackdropStyleConfig public float FixedOpacity { get; init; } /// - /// Gets whether this backdrop style supports custom colorization (tint colors). + /// Gets a value indicating whether this backdrop style supports custom colorization (tint colors). /// public bool SupportsColorization { get; init; } = true; /// - /// Gets whether this backdrop style supports custom background images. + /// Gets a value indicating whether this backdrop style supports custom background images. /// public bool SupportsBackgroundImage { get; init; } = true; /// - /// Gets whether this backdrop style supports opacity adjustment. + /// Gets a value indicating whether this backdrop style supports opacity adjustment. /// public bool SupportsOpacity { get; init; } = true; diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Services/ThemeSnapshot.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Services/ThemeSnapshot.cs index a82484d52f..a689cadf80 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Services/ThemeSnapshot.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Services/ThemeSnapshot.cs @@ -67,7 +67,7 @@ public sealed class ThemeSnapshot public required float BackgroundBrightness { get; init; } /// - /// Gets whether colorization is active (accent color, custom color, or image mode). + /// Gets a value indicating whether colorization is active (accent color, custom color, or image mode). /// public required bool HasColorization { get; init; } } diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Settings/DockSettings.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Settings/DockSettings.cs index ddf2a1a82e..a9ec6e0ee1 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Settings/DockSettings.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/Settings/DockSettings.cs @@ -93,19 +93,19 @@ public record DockBandSettings public required string CommandId { get; init; } /// - /// Gets or sets whether titles are shown for items in this band. + /// Gets whether titles are shown for items in this band. /// If null, falls back to dock-wide ShowLabels setting. /// public bool? ShowTitles { get; init; } /// - /// Gets or sets whether subtitles are shown for items in this band. + /// Gets whether subtitles are shown for items in this band. /// If null, falls back to dock-wide ShowLabels setting. /// public bool? ShowSubtitles { get; init; } /// - /// Gets or sets a value for backward compatibility. Maps to ShowTitles. + /// Gets a value for backward compatibility. Maps to ShowTitles. /// [System.Text.Json.Serialization.JsonIgnore] public bool? ShowLabels diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/WindowPosition.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/WindowPosition.cs index ac0dfddf58..9eda30d221 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/WindowPosition.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/WindowPosition.cs @@ -9,37 +9,37 @@ namespace Microsoft.CmdPal.UI.ViewModels; public sealed class WindowPosition { /// - /// Gets or sets left position in device pixels. + /// Gets the left position in device pixels. /// public int X { get; init; } /// - /// Gets or sets top position in device pixels. + /// Gets the top position in device pixels. /// public int Y { get; init; } /// - /// Gets or sets width in device pixels. + /// Gets the width in device pixels. /// public int Width { get; init; } /// - /// Gets or sets height in device pixels. + /// Gets the height in device pixels. /// public int Height { get; init; } /// - /// Gets or sets width of the screen in device pixels where the window is located. + /// Gets the width of the screen in device pixels where the window is located. /// public int ScreenWidth { get; init; } /// - /// Gets or sets height of the screen in device pixels where the window is located. + /// Gets the height of the screen in device pixels where the window is located. /// public int ScreenHeight { get; init; } /// - /// Gets or sets DPI (dots per inch) of the display where the window is located. + /// Gets the DPI (dots per inch) of the display where the window is located. /// public int Dpi { get; init; } diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalDockConfiguration.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalDockConfiguration.cs index 9664a229c8..8928a2e946 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalDockConfiguration.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalDockConfiguration.cs @@ -18,7 +18,7 @@ namespace Microsoft.CmdPal.UI.Events; public class CmdPalDockConfiguration : EventBase, IEvent { /// - /// Gets or sets whether the dock is enabled. + /// Gets or sets a value indicating whether the dock is enabled. /// public bool IsDockEnabled { get; set; } diff --git a/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalExtensionInvoked.cs b/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalExtensionInvoked.cs index 0113a4ad27..08aca00932 100644 --- a/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalExtensionInvoked.cs +++ b/src/modules/cmdpal/Microsoft.CmdPal.UI/Events/CmdPalExtensionInvoked.cs @@ -33,7 +33,7 @@ public class CmdPalExtensionInvoked : EventBase, IEvent public string CommandName { get; set; } /// - /// Gets or sets whether the command executed successfully. + /// Gets or sets a value indicating whether the command executed successfully. /// public bool Success { get; set; } diff --git a/src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Apps/AllAppsSettings.cs b/src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Apps/AllAppsSettings.cs index fb90a7fe9a..6991d7d864 100644 --- a/src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Apps/AllAppsSettings.cs +++ b/src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Apps/AllAppsSettings.cs @@ -76,7 +76,7 @@ public class AllAppsSettings : JsonSettingsManager, ISettingsInterface }; /// - /// Parsed search result limit. Returns when the caller should + /// Gets the parsed search result limit. Returns when the caller should /// use its own default (unrecognized value, empty, or old stored "0"). /// public int? SearchResultLimit diff --git a/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/ShellHelpers.cs b/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/ShellHelpers.cs index 3ddbcc5ad6..42b3114c8a 100644 --- a/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/ShellHelpers.cs +++ b/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/ShellHelpers.cs @@ -12,7 +12,7 @@ namespace Microsoft.CommandPalette.Extensions.Toolkit; public static class ShellHelpers { /// - /// These are the executable file extensions that Windows Shell recognizes. Unlike CMD/PowerShell, + /// Gets the executable file extensions that Windows Shell recognizes. Unlike CMD/PowerShell, /// Shell does not use PATHEXT, but has a magic fixed list. /// public static string[] ExecutableExtensions { get; } = [".PIF", ".COM", ".EXE", ".BAT", ".CMD"]; diff --git a/src/modules/powerdisplay/PowerDisplay.Lib/Utils/VcpNames.cs b/src/modules/powerdisplay/PowerDisplay.Lib/Utils/VcpNames.cs index 1ecd5f150e..170d43ed0b 100644 --- a/src/modules/powerdisplay/PowerDisplay.Lib/Utils/VcpNames.cs +++ b/src/modules/powerdisplay/PowerDisplay.Lib/Utils/VcpNames.cs @@ -17,7 +17,7 @@ namespace PowerDisplay.Common.Utils public static class VcpNames { /// - /// Optional delegate to provide localized VCP code names. + /// Gets or sets the optional delegate to provide localized VCP code names. /// Set this at application startup to enable localization. /// The delegate receives a VCP code and should return the localized name, or null to use the default. /// diff --git a/src/settings-ui/Settings.UI.Library/PowerDisplayProperties.cs b/src/settings-ui/Settings.UI.Library/PowerDisplayProperties.cs index cae991fabd..0ce0ae496d 100644 --- a/src/settings-ui/Settings.UI.Library/PowerDisplayProperties.cs +++ b/src/settings-ui/Settings.UI.Library/PowerDisplayProperties.cs @@ -48,7 +48,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library public bool ShowSystemTrayIcon { get; set; } /// - /// Gets or sets whether to show the profile switcher button in the flyout UI. + /// Gets or sets a value indicating whether to show the profile switcher button in the flyout UI. /// Default is true. When false, the profile switcher is hidden (but profiles still work via Settings). /// Note: Also hidden when no profiles exist. /// @@ -56,7 +56,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library public bool ShowProfileSwitcher { get; set; } /// - /// Gets or sets whether to show the identify monitors button in the flyout UI. + /// Gets or sets a value indicating whether to show the identify monitors button in the flyout UI. /// Default is true. /// [JsonPropertyName("show_identify_monitors_button")] diff --git a/src/settings-ui/Settings.UI/ViewModels/PowerDisplayViewModel.cs b/src/settings-ui/Settings.UI/ViewModels/PowerDisplayViewModel.cs index f4c93bd2a8..7073b7ebbc 100644 --- a/src/settings-ui/Settings.UI/ViewModels/PowerDisplayViewModel.cs +++ b/src/settings-ui/Settings.UI/ViewModels/PowerDisplayViewModel.cs @@ -465,7 +465,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels public ObservableCollection CustomVcpMappings => _customVcpMappings; /// - /// Gets whether there are any custom VCP mappings (for UI binding) + /// Gets a value indicating whether there are any custom VCP mappings (for UI binding). /// public bool HasCustomVcpMappings => _customVcpMappings?.Count > 0; @@ -475,7 +475,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels public ObservableCollection Profiles => _profiles; /// - /// Gets whether there are any profiles (for UI binding) + /// Gets a value indicating whether there are any profiles (for UI binding). /// public bool HasProfiles => _profiles?.Count > 0;