Fix SA1614: Add text to empty parameter documentation (#46706)

Add meaningful descriptions to 3 empty param XML doc tags in
BaseDscTest.cs and ShellHelpers.cs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Clint Rutkas
2026-04-01 20:41:59 -07:00
committed by GitHub
parent 4dfdf46e0d
commit fd5be6d04e
2 changed files with 3 additions and 3 deletions

View File

@@ -36,7 +36,7 @@ public class BaseDscTest
/// Execute a dsc command with the provided arguments. /// Execute a dsc command with the provided arguments.
/// </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">The command-line arguments to pass to the DSC command.</param>
/// <returns>The result of the DSC command execution.</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

@@ -246,8 +246,8 @@ public static class ShellHelpers
/// <summary> /// <summary>
/// Mimics Windows Shell behavior to resolve an executable name to a full path. /// Mimics Windows Shell behavior to resolve an executable name to a full path.
/// </summary> /// </summary>
/// <param name="name"></param> /// <param name="name">The name of the executable to resolve.</param>
/// <param name="fullPath"></param> /// <param name="fullPath">When this method returns, contains the full path to the executable if found; otherwise, <see langword="null"/>.</param>
/// <returns><see langword="true"/> if the executable was resolved to a full path; otherwise, <see langword="false"/>.</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)
{ {