diff --git a/src/ModularPipelines/Context/IDownloader.cs b/src/ModularPipelines/Context/IDownloader.cs index 75495e31fa..1dfdba72c5 100644 --- a/src/ModularPipelines/Context/IDownloader.cs +++ b/src/ModularPipelines/Context/IDownloader.cs @@ -6,26 +6,26 @@ namespace ModularPipelines.Context; public interface IDownloader { /// - /// Used to download a file from the web and save to the local machine. + /// Downloads a file from the web and saves it to the local machine. /// - /// - /// - /// A representing the asynchronous operation. + /// The download options including the source URL and destination path. + /// A token to cancel the download operation. + /// The downloaded file. public Task DownloadFileAsync(DownloadFileOptions options, CancellationToken cancellationToken = default); /// - /// Used to download a string from the web. + /// Downloads content from the web as a string. /// - /// - /// - /// A representing the asynchronous operation. + /// The download options including the source URL. + /// A token to cancel the download operation. + /// The downloaded content as a string, or null if the download failed. public Task DownloadStringAsync(DownloadOptions options, CancellationToken cancellationToken = default); /// - /// Used to get a response from the web. + /// Gets an HTTP response from the web. /// - /// - /// - /// A representing the asynchronous operation. + /// The download options including the source URL. + /// A token to cancel the download operation. + /// The HTTP response message. public Task DownloadResponseAsync(DownloadOptions options, CancellationToken cancellationToken = default); -} \ No newline at end of file +} diff --git a/src/ModularPipelines/Context/IEnvironmentContext.cs b/src/ModularPipelines/Context/IEnvironmentContext.cs index f3a7ca6527..58ffc81e65 100644 --- a/src/ModularPipelines/Context/IEnvironmentContext.cs +++ b/src/ModularPipelines/Context/IEnvironmentContext.cs @@ -19,6 +19,9 @@ public interface IEnvironmentContext /// public OperatingSystemIdentifier OperatingSystem { get; } + /// + /// Gets the version of the current operating system. + /// public Version OperatingSystemVersion { get; } /// diff --git a/src/ModularPipelines/IBuildSystemDetector.cs b/src/ModularPipelines/IBuildSystemDetector.cs index db5cca2d63..e4f3de35d7 100644 --- a/src/ModularPipelines/IBuildSystemDetector.cs +++ b/src/ModularPipelines/IBuildSystemDetector.cs @@ -61,6 +61,7 @@ public interface IBuildSystemDetector /// /// Gets a value indicating whether the current build agent is the type specified. /// - /// True if it is the current build agent type. + /// The build system type to check for. + /// True if the pipeline is running on the specified build system; otherwise, false. bool Is(BuildSystem buildSystem) => GetCurrentBuildSystem() == buildSystem; } \ No newline at end of file