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:
Clint Rutkas
2026-04-01 12:58:09 -07:00
committed by GitHub
parent 0da5602f68
commit 76b773b016
6 changed files with 29 additions and 7 deletions

View File

@@ -48,7 +48,6 @@ nupkg
petabyte petabyte
resw resw
resx resx
runtimeconfig
srt srt
Stereolithography Stereolithography
terabyte terabyte
@@ -341,6 +340,29 @@ WINEVENTPROC
WORKERW WORKERW
FULLSCREENAPP 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) # PowerRename metadata pattern abbreviations (used in tests and regex patterns)
DDDD DDDD
FFF FFF

View File

@@ -26,7 +26,7 @@ public class BaseDscTest
/// </summary> /// </summary>
/// <param name="name">The name of the resource string.</param> /// <param name="name">The name of the resource string.</param>
/// <param name="args">The arguments to format the resource string with.</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) public string GetResourceString(string name, params string[] args)
{ {
return string.Format(CultureInfo.InvariantCulture, _resourceManager.GetString(name, CultureInfo.InvariantCulture), args); return string.Format(CultureInfo.InvariantCulture, _resourceManager.GetString(name, CultureInfo.InvariantCulture), args);
@@ -37,7 +37,7 @@ public class BaseDscTest
/// </summary> /// </summary>
/// <typeparam name="T">The type of the DSC command to execute.</typeparam> /// <typeparam name="T">The type of the DSC command to execute.</typeparam>
/// <param name="args"></param> /// <param name="args"></param>
/// <returns></returns> /// <returns>The result of the DSC command execution.</returns>
protected DscExecuteResult ExecuteDscCommand<T>(params string[] args) protected DscExecuteResult ExecuteDscCommand<T>(params string[] args)
where T : Command, new() where T : Command, new()
{ {

View File

@@ -47,6 +47,6 @@ public interface ISettingsFunctionData
/// <summary> /// <summary>
/// Gets the schema for the settings resource object. /// Gets the schema for the settings resource object.
/// </summary> /// </summary>
/// <returns></returns> /// <returns>The JSON schema string for the settings resource object.</returns>
public string Schema(); public string Schema();
} }

View File

@@ -37,7 +37,7 @@ public class BaseResourceObject
/// <summary> /// <summary>
/// Generates a JSON representation of the resource object. /// Generates a JSON representation of the resource object.
/// </summary> /// </summary>
/// <returns></returns> /// <returns>A JSON representation of the resource object.</returns>
public JsonNode ToJson() public JsonNode ToJson()
{ {
return JsonSerializer.SerializeToNode(this, GetType(), _options) ?? new JsonObject(); return JsonSerializer.SerializeToNode(this, GetType(), _options) ?? new JsonObject();

View File

@@ -12,6 +12,6 @@ public interface IBrowserInfoService
/// <summary> /// <summary>
/// Gets information about the system's default web browser. /// Gets information about the system's default web browser.
/// </summary> /// </summary>
/// <returns></returns> /// <returns>The default browser information, or <see langword="null"/> if it could not be determined.</returns>
BrowserInfo? GetDefaultBrowser(); BrowserInfo? GetDefaultBrowser();
} }

View File

@@ -248,7 +248,7 @@ public static class ShellHelpers
/// </summary> /// </summary>
/// <param name="name"></param> /// <param name="name"></param>
/// <param name="fullPath"></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) public static bool TryResolveExecutableAsShell(string name, out string fullPath)
{ {
// First check if we can find the file in the registry // First check if we can find the file in the registry