Skip to content

Commit 60e62f0

Browse files
thomhurstclaude
andauthored
docs: Add XML documentation to IZip interface (#1737)
Add comprehensive XML documentation for the IZip interface including: - Interface-level summary describing ZIP compression/decompression functionality - ZipFolder method overloads with parameter and return value documentation - UnZipToFolder method overloads with parameter and return value documentation Fixes #1517 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a2bcc35 commit 60e62f0

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

  • src/ModularPipelines/Context

src/ModularPipelines/Context/IZip.cs

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,42 @@
44

55
namespace ModularPipelines.Context;
66

7+
/// <summary>
8+
/// Provides ZIP compression and decompression functionality for folders and files.
9+
/// </summary>
710
public interface IZip
811
{
12+
/// <summary>
13+
/// Compresses a folder into a ZIP file using optimal compression level.
14+
/// </summary>
15+
/// <param name="folder">The folder to compress.</param>
16+
/// <param name="outputPath">The path where the ZIP file will be created.</param>
17+
/// <returns>A <see cref="File"/> representing the created ZIP file.</returns>
918
public File ZipFolder(Folder folder, string outputPath) => ZipFolder(folder, outputPath, CompressionLevel.Optimal);
1019

20+
/// <summary>
21+
/// Compresses a folder into a ZIP file with the specified compression level.
22+
/// </summary>
23+
/// <param name="folder">The folder to compress.</param>
24+
/// <param name="outputPath">The path where the ZIP file will be created.</param>
25+
/// <param name="compressionLevel">The level of compression to use.</param>
26+
/// <returns>A <see cref="File"/> representing the created ZIP file.</returns>
1127
public File ZipFolder(Folder folder, string outputPath, CompressionLevel compressionLevel);
1228

29+
/// <summary>
30+
/// Extracts a ZIP file to a folder, overwriting existing files by default.
31+
/// </summary>
32+
/// <param name="zipPath">The path to the ZIP file to extract.</param>
33+
/// <param name="outputFolderPath">The path where the contents will be extracted.</param>
34+
/// <returns>A <see cref="Folder"/> representing the extraction destination folder.</returns>
1335
public Folder UnZipToFolder(string zipPath, string outputFolderPath) => UnZipToFolder(zipPath, outputFolderPath, true);
1436

37+
/// <summary>
38+
/// Extracts a ZIP file to a folder with control over whether to overwrite existing files.
39+
/// </summary>
40+
/// <param name="zipPath">The path to the ZIP file to extract.</param>
41+
/// <param name="outputFolderPath">The path where the contents will be extracted.</param>
42+
/// <param name="overwriteFiles">If <c>true</c>, existing files will be overwritten; otherwise, an exception is thrown for conflicts.</param>
43+
/// <returns>A <see cref="Folder"/> representing the extraction destination folder.</returns>
1544
public Folder UnZipToFolder(string zipPath, string outputFolderPath, bool overwriteFiles);
1645
}

0 commit comments

Comments
 (0)