Skip to content

Commit 0d61284

Browse files
Update documentation for IO.Compression (#120840)
Follow-up PR for #120495 Fills in missing return tags
1 parent ce9375b commit 0d61284

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Create.Async.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ public static Task CreateFromDirectoryAsync(string sourceDirectoryName, string d
264264
/// be included at the root of the archive. <code>false</code> to indicate that the files and directories in <code>sourceDirectoryName</code>
265265
/// should be included directly in the archive.</param>
266266
/// <param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>
267+
/// <returns>A task that represents the asynchronous create operation. The task completes when the archive has been written to disk.</returns>
267268
public static Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, CompressionLevel compressionLevel, bool includeBaseDirectory, CancellationToken cancellationToken = default) =>
268269
DoCreateFromDirectoryAsync(sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory, entryNameEncoding: null, cancellationToken);
269270

@@ -335,6 +336,7 @@ public static Task CreateFromDirectoryAsync(string sourceDirectoryName, string d
335336
/// otherwise an <see cref="ArgumentException"/> is thrown.</para>
336337
/// </param>
337338
/// <param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>
339+
/// <returns>A task that represents the asynchronous create operation. The task completes when the archive has been written to disk.</returns>
338340
public static Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName,
339341
CompressionLevel compressionLevel, bool includeBaseDirectory, Encoding? entryNameEncoding, CancellationToken cancellationToken = default) =>
340342
DoCreateFromDirectoryAsync(sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory, entryNameEncoding, cancellationToken);
@@ -392,6 +394,7 @@ public static Task CreateFromDirectoryAsync(string sourceDirectoryName, Stream d
392394
/// <exception cref="NotSupportedException"><paramref name="sourceDirectoryName" /> contains an invalid format.</exception>
393395
/// <exception cref="ArgumentOutOfRangeException"><paramref name="compressionLevel"/> is not a valid <see cref="CompressionLevel"/> value.</exception>
394396
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
397+
/// <returns>A task that represents the asynchronous create operation. The task completes when the archive has been written to the specified stream.</returns>
395398
public static Task CreateFromDirectoryAsync(string sourceDirectoryName, Stream destination, CompressionLevel compressionLevel, bool includeBaseDirectory, CancellationToken cancellationToken = default) =>
396399
DoCreateFromDirectoryAsync(sourceDirectoryName, destination, compressionLevel, includeBaseDirectory, entryNameEncoding: null, cancellationToken);
397400

@@ -422,6 +425,7 @@ public static Task CreateFromDirectoryAsync(string sourceDirectoryName, Stream d
422425
/// <exception cref="NotSupportedException"><paramref name="sourceDirectoryName" /> contains an invalid format.</exception>
423426
/// <exception cref="ArgumentOutOfRangeException"><paramref name="compressionLevel"/> is not a valid <see cref="CompressionLevel"/> value.</exception>
424427
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
428+
/// <returns>A task that represents the asynchronous create operation. The task completes when the archive has been written to the specified stream.</returns>
425429
public static Task CreateFromDirectoryAsync(string sourceDirectoryName, Stream destination,
426430
CompressionLevel compressionLevel, bool includeBaseDirectory, Encoding? entryNameEncoding, CancellationToken cancellationToken = default) =>
427431
DoCreateFromDirectoryAsync(sourceDirectoryName, destination, compressionLevel, includeBaseDirectory, entryNameEncoding, cancellationToken);

src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Extract.Async.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ public static Task ExtractToDirectoryAsync(string sourceArchiveFileName, string
133133
/// otherwise an <see cref="ArgumentException"/> is thrown.</para>
134134
/// </param>
135135
/// <param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>
136+
/// <returns>A task that represents the asynchronous extract operation. The task completes when all entries have been extracted or an error occurs.</returns>
136137
public static Task ExtractToDirectoryAsync(string sourceArchiveFileName, string destinationDirectoryName, Encoding? entryNameEncoding, CancellationToken cancellationToken = default) =>
137138
ExtractToDirectoryAsync(sourceArchiveFileName, destinationDirectoryName, entryNameEncoding: entryNameEncoding, overwriteFiles: false, cancellationToken);
138139

@@ -231,6 +232,7 @@ public static async Task ExtractToDirectoryAsync(string sourceArchiveFileName, s
231232
/// -or-
232233
/// An archive entry was compressed by using a compression method that is not supported.</exception>
233234
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
235+
/// <returns>A task that represents the asynchronous extract operation. The task completes when all entries have been extracted or an error occurs.</returns>
234236
public static Task ExtractToDirectoryAsync(Stream source, string destinationDirectoryName, CancellationToken cancellationToken = default) =>
235237
ExtractToDirectoryAsync(source, destinationDirectoryName, entryNameEncoding: null, overwriteFiles: false, cancellationToken);
236238

@@ -262,6 +264,7 @@ public static Task ExtractToDirectoryAsync(Stream source, string destinationDire
262264
/// -or-
263265
/// An archive entry was compressed by using a compression method that is not supported.</exception>
264266
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
267+
/// <returns>A task that represents the asynchronous extract operation. The task completes when all entries have been extracted or an error occurs.</returns>
265268
public static Task ExtractToDirectoryAsync(Stream source, string destinationDirectoryName, bool overwriteFiles, CancellationToken cancellationToken = default) =>
266269
ExtractToDirectoryAsync(source, destinationDirectoryName, entryNameEncoding: null, overwriteFiles: overwriteFiles, cancellationToken);
267270

@@ -301,6 +304,7 @@ public static Task ExtractToDirectoryAsync(Stream source, string destinationDire
301304
/// -or-
302305
/// An archive entry was compressed by using a compression method that is not supported.</exception>
303306
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
307+
/// <returns>A task that represents the asynchronous extract operation. The task completes when all entries have been extracted or an error occurs.</returns>
304308
public static Task ExtractToDirectoryAsync(Stream source, string destinationDirectoryName, Encoding? entryNameEncoding, CancellationToken cancellationToken = default) =>
305309
ExtractToDirectoryAsync(source, destinationDirectoryName, entryNameEncoding: entryNameEncoding, overwriteFiles: false, cancellationToken);
306310

@@ -341,6 +345,7 @@ public static Task ExtractToDirectoryAsync(Stream source, string destinationDire
341345
/// -or-
342346
/// An archive entry was compressed by using a compression method that is not supported.</exception>
343347
/// <exception cref="OperationCanceledException">An asynchronous operation is cancelled.</exception>
348+
/// <returns>A task that represents the asynchronous extract operation. The task completes when all entries have been extracted or an error occurs.</returns>
344349
public static async Task ExtractToDirectoryAsync(Stream source, string destinationDirectoryName, Encoding? entryNameEncoding, bool overwriteFiles, CancellationToken cancellationToken = default)
345350
{
346351
cancellationToken.ThrowIfCancellationRequested();

0 commit comments

Comments
 (0)