Skip to content

Commit 71e8f02

Browse files
thomhurstclaude
andcommitted
docs: Add XML documentation to installer interfaces
Add comprehensive XML documentation to: - IFileInstaller: Methods for installing from local files or web URLs - ILinuxInstaller: Methods for installing on Linux systems (dpkg) - IWindowsInstaller: Methods for installing on Windows (MSI, EXE) - IMacInstaller: Methods for installing on macOS (Homebrew) Fixes #1551 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent b78a2ea commit 71e8f02

4 files changed

Lines changed: 44 additions & 0 deletions

File tree

src/ModularPipelines/Context/IFileInstaller.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,26 @@
33

44
namespace ModularPipelines.Context;
55

6+
/// <summary>
7+
/// Provides methods for installing software from local files or web URLs.
8+
/// </summary>
69
public interface IFileInstaller
710
{
11+
/// <summary>
12+
/// Installs software from a local installer file.
13+
/// </summary>
14+
/// <param name="options">The options specifying the installer file path and installation parameters.</param>
15+
/// <param name="cancellationToken">A token to cancel the installation operation.</param>
16+
/// <returns>A <see cref="CommandResult"/> containing the result of the installation command.</returns>
817
Task<CommandResult> InstallFromFileAsync(InstallerOptions options,
918
CancellationToken cancellationToken = default);
1019

20+
/// <summary>
21+
/// Downloads and installs software from a web URL.
22+
/// </summary>
23+
/// <param name="options">The options specifying the download URL and installation parameters.</param>
24+
/// <param name="cancellationToken">A token to cancel the download and installation operation.</param>
25+
/// <returns>A <see cref="CommandResult"/> containing the result of the installation command.</returns>
1126
Task<CommandResult> InstallFromWebAsync(WebInstallerOptions options,
1227
CancellationToken cancellationToken = default);
1328
}

src/ModularPipelines/Context/ILinuxInstaller.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33

44
namespace ModularPipelines.Context;
55

6+
/// <summary>
7+
/// Provides methods for installing software on Linux systems.
8+
/// </summary>
69
public interface ILinuxInstaller
710
{
11+
/// <summary>
12+
/// Installs a Debian package using dpkg.
13+
/// </summary>
14+
/// <param name="options">The options specifying the package file and installation parameters.</param>
15+
/// <returns>A <see cref="CommandResult"/> containing the result of the dpkg installation command.</returns>
816
Task<CommandResult> InstallFromDpkg(DpkgInstallOptions options);
917
}

src/ModularPipelines/Context/IMacInstaller.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33

44
namespace ModularPipelines.Context;
55

6+
/// <summary>
7+
/// Provides methods for installing software on macOS systems.
8+
/// </summary>
69
public interface IMacInstaller
710
{
11+
/// <summary>
12+
/// Installs software using Homebrew package manager.
13+
/// </summary>
14+
/// <param name="macBrewOptions">The options specifying the package name and installation parameters.</param>
15+
/// <returns>A <see cref="CommandResult"/> containing the result of the Homebrew installation command.</returns>
816
Task<CommandResult> InstallFromBrew(MacBrewOptions macBrewOptions);
917
}

src/ModularPipelines/Context/IWindowsInstaller.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,22 @@
33

44
namespace ModularPipelines.Context;
55

6+
/// <summary>
7+
/// Provides methods for installing software on Windows systems.
8+
/// </summary>
69
public interface IWindowsInstaller
710
{
11+
/// <summary>
12+
/// Installs software from an MSI (Windows Installer) package.
13+
/// </summary>
14+
/// <param name="msiInstallerOptions">The options specifying the MSI file path and installation parameters.</param>
15+
/// <returns>A <see cref="CommandResult"/> containing the result of the MSI installation command.</returns>
816
Task<CommandResult> InstallMsi(MsiInstallerOptions msiInstallerOptions);
917

18+
/// <summary>
19+
/// Installs software from an executable installer.
20+
/// </summary>
21+
/// <param name="exeInstallerOptions">The options specifying the executable file path and installation parameters.</param>
22+
/// <returns>A <see cref="CommandResult"/> containing the result of the executable installation command.</returns>
1023
Task<CommandResult> InstallExe(ExeInstallerOptions exeInstallerOptions);
1124
}

0 commit comments

Comments
 (0)