From 8b36bda04b72e90c39f853670b99583a45b6d9e3 Mon Sep 17 00:00:00 2001
From: Tom Longhurst <30480171+thomhurst@users.noreply.github.com>
Date: Thu, 1 Jan 2026 22:21:24 +0000
Subject: [PATCH] docs: Add XML documentation to IZip interface
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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>
---
 src/ModularPipelines/Context/IZip.cs | 29 ++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/src/ModularPipelines/Context/IZip.cs b/src/ModularPipelines/Context/IZip.cs
index 5c5c8330bf..5c2dc1ac01 100644
--- a/src/ModularPipelines/Context/IZip.cs
+++ b/src/ModularPipelines/Context/IZip.cs
@@ -4,13 +4,42 @@
 
 namespace ModularPipelines.Context;
 
+/// <summary>
+/// Provides ZIP compression and decompression functionality for folders and files.
+/// </summary>
 public interface IZip
 {
+    /// <summary>
+    /// Compresses a folder into a ZIP file using optimal compression level.
+    /// </summary>
+    /// <param name="folder">The folder to compress.</param>
+    /// <param name="outputPath">The path where the ZIP file will be created.</param>
+    /// <returns>A <see cref="File"/> representing the created ZIP file.</returns>
     public File ZipFolder(Folder folder, string outputPath) => ZipFolder(folder, outputPath, CompressionLevel.Optimal);
 
+    /// <summary>
+    /// Compresses a folder into a ZIP file with the specified compression level.
+    /// </summary>
+    /// <param name="folder">The folder to compress.</param>
+    /// <param name="outputPath">The path where the ZIP file will be created.</param>
+    /// <param name="compressionLevel">The level of compression to use.</param>
+    /// <returns>A <see cref="File"/> representing the created ZIP file.</returns>
     public File ZipFolder(Folder folder, string outputPath, CompressionLevel compressionLevel);
 
+    /// <summary>
+    /// Extracts a ZIP file to a folder, overwriting existing files by default.
+    /// </summary>
+    /// <param name="zipPath">The path to the ZIP file to extract.</param>
+    /// <param name="outputFolderPath">The path where the contents will be extracted.</param>
+    /// <returns>A <see cref="Folder"/> representing the extraction destination folder.</returns>
     public Folder UnZipToFolder(string zipPath, string outputFolderPath) => UnZipToFolder(zipPath, outputFolderPath, true);
 
+    /// <summary>
+    /// Extracts a ZIP file to a folder with control over whether to overwrite existing files.
+    /// </summary>
+    /// <param name="zipPath">The path to the ZIP file to extract.</param>
+    /// <param name="outputFolderPath">The path where the contents will be extracted.</param>
+    /// <param name="overwriteFiles">If <c>true</c>, existing files will be overwritten; otherwise, an exception is thrown for conflicts.</param>
+    /// <returns>A <see cref="Folder"/> representing the extraction destination folder.</returns>
     public Folder UnZipToFolder(string zipPath, string outputFolderPath, bool overwriteFiles);
 }
\ No newline at end of file