mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 09:46:54 +02:00
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>
This commit is contained in:
@@ -12,7 +12,7 @@ public struct InterlockedBoolean(bool initialValue = false)
|
|||||||
private int _value = initialValue ? 1 : 0;
|
private int _value = initialValue ? 1 : 0;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the boolean value atomically
|
/// Gets or sets a value indicating whether the atomic boolean is true.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool Value
|
public bool Value
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -8,6 +8,6 @@ public sealed class PinyinFuzzyMatcherOptions
|
|||||||
{
|
{
|
||||||
public PinyinMode Mode { get; init; } = PinyinMode.AutoSimplifiedChineseUi;
|
public PinyinMode Mode { get; init; } = PinyinMode.AutoSimplifiedChineseUi;
|
||||||
|
|
||||||
/// <summary>Remove IME syllable separators (') for query secondary variant.</summary>
|
/// <summary>Gets a value indicating whether IME syllable separators (') are removed for query secondary variant.</summary>
|
||||||
public bool RemoveApostrophesForQuery { get; init; } = true;
|
public bool RemoveApostrophesForQuery { get; init; } = true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -341,25 +341,25 @@ public sealed partial class AppearanceSettingsViewModel : ObservableObject, IDis
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether the backdrop opacity slider should be visible.
|
/// Gets a value indicating whether the backdrop opacity slider should be visible.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool IsBackdropOpacityVisible =>
|
public bool IsBackdropOpacityVisible =>
|
||||||
BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity;
|
BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool IsMicaBackdropDescriptionVisible =>
|
public bool IsMicaBackdropDescriptionVisible =>
|
||||||
!BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity;
|
!BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsOpacity;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether background/colorization settings are available.
|
/// Gets a value indicating whether background/colorization settings are available.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool IsBackgroundSettingsEnabled =>
|
public bool IsBackgroundSettingsEnabled =>
|
||||||
BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization;
|
BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool IsBackgroundNotAvailableVisible =>
|
public bool IsBackgroundNotAvailableVisible =>
|
||||||
!BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization;
|
!BackdropStyles.Get(_settingsService.Settings.BackdropStyle).SupportsColorization;
|
||||||
|
|||||||
@@ -36,17 +36,17 @@ public sealed record BackdropStyleConfig
|
|||||||
public float FixedOpacity { get; init; }
|
public float FixedOpacity { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether this backdrop style supports custom colorization (tint colors).
|
/// Gets a value indicating whether this backdrop style supports custom colorization (tint colors).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool SupportsColorization { get; init; } = true;
|
public bool SupportsColorization { get; init; } = true;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether this backdrop style supports custom background images.
|
/// Gets a value indicating whether this backdrop style supports custom background images.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool SupportsBackgroundImage { get; init; } = true;
|
public bool SupportsBackgroundImage { get; init; } = true;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether this backdrop style supports opacity adjustment.
|
/// Gets a value indicating whether this backdrop style supports opacity adjustment.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool SupportsOpacity { get; init; } = true;
|
public bool SupportsOpacity { get; init; } = true;
|
||||||
|
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ public sealed class ThemeSnapshot
|
|||||||
public required float BackgroundBrightness { get; init; }
|
public required float BackgroundBrightness { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public required bool HasColorization { get; init; }
|
public required bool HasColorization { get; init; }
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -93,19 +93,19 @@ public record DockBandSettings
|
|||||||
public required string CommandId { get; init; }
|
public required string CommandId { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
/// If null, falls back to dock-wide ShowLabels setting.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool? ShowTitles { get; init; }
|
public bool? ShowTitles { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
/// If null, falls back to dock-wide ShowLabels setting.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool? ShowSubtitles { get; init; }
|
public bool? ShowSubtitles { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets a value for backward compatibility. Maps to ShowTitles.
|
/// Gets a value for backward compatibility. Maps to ShowTitles.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[System.Text.Json.Serialization.JsonIgnore]
|
[System.Text.Json.Serialization.JsonIgnore]
|
||||||
public bool? ShowLabels
|
public bool? ShowLabels
|
||||||
|
|||||||
@@ -9,37 +9,37 @@ namespace Microsoft.CmdPal.UI.ViewModels;
|
|||||||
public sealed class WindowPosition
|
public sealed class WindowPosition
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets left position in device pixels.
|
/// Gets the left position in device pixels.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int X { get; init; }
|
public int X { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets top position in device pixels.
|
/// Gets the top position in device pixels.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int Y { get; init; }
|
public int Y { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets width in device pixels.
|
/// Gets the width in device pixels.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int Width { get; init; }
|
public int Width { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets height in device pixels.
|
/// Gets the height in device pixels.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int Height { get; init; }
|
public int Height { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int ScreenWidth { get; init; }
|
public int ScreenWidth { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int ScreenHeight { get; init; }
|
public int ScreenHeight { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int Dpi { get; init; }
|
public int Dpi { get; init; }
|
||||||
|
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ namespace Microsoft.CmdPal.UI.Events;
|
|||||||
public class CmdPalDockConfiguration : EventBase, IEvent
|
public class CmdPalDockConfiguration : EventBase, IEvent
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets whether the dock is enabled.
|
/// Gets or sets a value indicating whether the dock is enabled.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool IsDockEnabled { get; set; }
|
public bool IsDockEnabled { get; set; }
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ public class CmdPalExtensionInvoked : EventBase, IEvent
|
|||||||
public string CommandName { get; set; }
|
public string CommandName { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets whether the command executed successfully.
|
/// Gets or sets a value indicating whether the command executed successfully.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool Success { get; set; }
|
public bool Success { get; set; }
|
||||||
|
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ public class AllAppsSettings : JsonSettingsManager, ISettingsInterface
|
|||||||
};
|
};
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Parsed search result limit. Returns <see langword="null"/> when the caller should
|
/// Gets the parsed search result limit. Returns <see langword="null"/> when the caller should
|
||||||
/// use its own default (unrecognized value, empty, or old stored "0").
|
/// use its own default (unrecognized value, empty, or old stored "0").
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? SearchResultLimit
|
public int? SearchResultLimit
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ namespace Microsoft.CommandPalette.Extensions.Toolkit;
|
|||||||
public static class ShellHelpers
|
public static class ShellHelpers
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
/// Shell does not use PATHEXT, but has a magic fixed list.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public static string[] ExecutableExtensions { get; } = [".PIF", ".COM", ".EXE", ".BAT", ".CMD"];
|
public static string[] ExecutableExtensions { get; } = [".PIF", ".COM", ".EXE", ".BAT", ".CMD"];
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ namespace PowerDisplay.Common.Utils
|
|||||||
public static class VcpNames
|
public static class VcpNames
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
/// 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.
|
/// The delegate receives a VCP code and should return the localized name, or null to use the default.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
|
|||||||
public bool ShowSystemTrayIcon { get; set; }
|
public bool ShowSystemTrayIcon { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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).
|
/// Default is true. When false, the profile switcher is hidden (but profiles still work via Settings).
|
||||||
/// Note: Also hidden when no profiles exist.
|
/// Note: Also hidden when no profiles exist.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
@@ -56,7 +56,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
|
|||||||
public bool ShowProfileSwitcher { get; set; }
|
public bool ShowProfileSwitcher { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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.
|
/// Default is true.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[JsonPropertyName("show_identify_monitors_button")]
|
[JsonPropertyName("show_identify_monitors_button")]
|
||||||
|
|||||||
@@ -465,7 +465,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
|
|||||||
public ObservableCollection<CustomVcpValueMapping> CustomVcpMappings => _customVcpMappings;
|
public ObservableCollection<CustomVcpValueMapping> CustomVcpMappings => _customVcpMappings;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 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).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool HasCustomVcpMappings => _customVcpMappings?.Count > 0;
|
public bool HasCustomVcpMappings => _customVcpMappings?.Count > 0;
|
||||||
|
|
||||||
@@ -475,7 +475,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
|
|||||||
public ObservableCollection<PowerDisplayProfile> Profiles => _profiles;
|
public ObservableCollection<PowerDisplayProfile> Profiles => _profiles;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets whether there are any profiles (for UI binding)
|
/// Gets a value indicating whether there are any profiles (for UI binding).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public bool HasProfiles => _profiles?.Count > 0;
|
public bool HasProfiles => _profiles?.Count > 0;
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user