Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-12-15 03:07:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Simplify ProfileService XML doc comments

Browse Source 
Removed the <remarks> section from the ProfileService class XML documentation, eliminating detailed design notes and usage guidelines. Only the summary description is now retained for clarity and brevity.
This commit is contained in:
Yu Leng
2025-12-11 10:28:44 +08:00
parent a4770a84cf
commit 75f57f53f2
1 changed files with 0 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/modules/powerdisplay/PowerDisplay.Lib/Services/ProfileService.cs
View File

@@ -17,20 +17,6 @@ namespace PowerDisplay.Common.Services
/// Provides unified access to profile data for PowerDisplay, Settings UI, and LightSwitch modules. /// Provides unified access to profile data for PowerDisplay, Settings UI, and LightSwitch modules.
/// Thread-safe and AOT-compatible. /// Thread-safe and AOT-compatible.
/// </summary> /// </summary>
/// <remarks>
/// <para><b>Design Note:</b> This class provides both static and instance-based access patterns:</para>
/// <list type="bullet">
/// <item><description>Static methods: Direct access for backward compatibility with existing code. Thread-safe with internal locking.</description></item>
/// <item><description>Instance methods (via <see cref="IProfileService"/>): For dependency injection consumers. Delegates to static methods internally.</description></item>
/// </list>
/// <para><b>Usage Guidelines:</b></para>
/// <list type="bullet">
/// <item><description>New code should prefer DI: <c>serviceProvider.GetService&lt;IProfileService&gt;()</c></description></item>
/// <item><description>Or use the singleton: <c>ProfileService.Instance.LoadProfiles()</c></description></item>
/// <item><description>Static methods remain available for backward compatibility</description></item>
/// </list>
/// <para>All access patterns are thread-safe and share the same underlying lock.</para>
/// </remarks>
public class ProfileService : IProfileService public class ProfileService : IProfileService
{ {
private const string LogPrefix = "[ProfileService]"; private const string LogPrefix = "[ProfileService]";