mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 01:36:31 +02:00
Fix SA1616: Add text to empty return value documentation (#46718)
Add meaningful descriptions to 6 empty returns XML doc tags across DSC, CmdPal, and Extensions.Toolkit. --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
24
.github/actions/spell-check/allow/code.txt
vendored
24
.github/actions/spell-check/allow/code.txt
vendored
@@ -48,7 +48,6 @@ nupkg
|
||||
petabyte
|
||||
resw
|
||||
resx
|
||||
runtimeconfig
|
||||
srt
|
||||
Stereolithography
|
||||
terabyte
|
||||
@@ -341,6 +340,29 @@ WINEVENTPROC
|
||||
WORKERW
|
||||
FULLSCREENAPP
|
||||
|
||||
# COM/WinRT interface prefixes and type fragments
|
||||
BAlt
|
||||
BShift
|
||||
Cmanifest
|
||||
Cmodule
|
||||
Cuuid
|
||||
Dng
|
||||
IApplication
|
||||
IDisposable
|
||||
IEnum
|
||||
IFolder
|
||||
IInitialize
|
||||
IMemory
|
||||
IOle
|
||||
ipreview
|
||||
IProperty
|
||||
IShell
|
||||
ithumbnail
|
||||
IVirtual
|
||||
|
||||
# Test frameworks
|
||||
MSTEST
|
||||
|
||||
# PowerRename metadata pattern abbreviations (used in tests and regex patterns)
|
||||
DDDD
|
||||
FFF
|
||||
|
||||
@@ -26,7 +26,7 @@ public class BaseDscTest
|
||||
/// </summary>
|
||||
/// <param name="name">The name of the resource string.</param>
|
||||
/// <param name="args">The arguments to format the resource string with.</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>The formatted resource string.</returns>
|
||||
public string GetResourceString(string name, params string[] args)
|
||||
{
|
||||
return string.Format(CultureInfo.InvariantCulture, _resourceManager.GetString(name, CultureInfo.InvariantCulture), args);
|
||||
@@ -37,7 +37,7 @@ public class BaseDscTest
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the DSC command to execute.</typeparam>
|
||||
/// <param name="args"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns>The result of the DSC command execution.</returns>
|
||||
protected DscExecuteResult ExecuteDscCommand<T>(params string[] args)
|
||||
where T : Command, new()
|
||||
{
|
||||
|
||||
@@ -47,6 +47,6 @@ public interface ISettingsFunctionData
|
||||
/// <summary>
|
||||
/// Gets the schema for the settings resource object.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
/// <returns>The JSON schema string for the settings resource object.</returns>
|
||||
public string Schema();
|
||||
}
|
||||
|
||||
@@ -37,7 +37,7 @@ public class BaseResourceObject
|
||||
/// <summary>
|
||||
/// Generates a JSON representation of the resource object.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
/// <returns>A JSON representation of the resource object.</returns>
|
||||
public JsonNode ToJson()
|
||||
{
|
||||
return JsonSerializer.SerializeToNode(this, GetType(), _options) ?? new JsonObject();
|
||||
|
||||
@@ -12,6 +12,6 @@ public interface IBrowserInfoService
|
||||
/// <summary>
|
||||
/// Gets information about the system's default web browser.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
/// <returns>The default browser information, or <see langword="null"/> if it could not be determined.</returns>
|
||||
BrowserInfo? GetDefaultBrowser();
|
||||
}
|
||||
|
||||
@@ -248,7 +248,7 @@ public static class ShellHelpers
|
||||
/// </summary>
|
||||
/// <param name="name"></param>
|
||||
/// <param name="fullPath"></param>
|
||||
/// <returns></returns>
|
||||
/// <returns><see langword="true"/> if the executable was resolved to a full path; otherwise, <see langword="false"/>.</returns>
|
||||
public static bool TryResolveExecutableAsShell(string name, out string fullPath)
|
||||
{
|
||||
// First check if we can find the file in the registry
|
||||
|
||||
Reference in New Issue
Block a user