You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Initial documentation for System.IO.Compression.BrotliStream, amending GZipStream/DeflateStream (#2001)
* Add documentation change for System.IO.Compression API classes: BrotliStream, DeflateStream, GZipStream.
* First change for BrotliStream to make it look like GZipStream and DeflateStream.
* Apply suggestions from code review
Removing the 3 unexpected dots and the incorrectly closed remark.
Co-Authored-By: carlossanlop <[email protected]>
* Update BrotliStream.xml
Removed the 2 comments with questions for reviewers.
* Update GZipStream.xml
Revert the change in ReadAsync. There is no method in GZipStream with 3 arguments byte[], int, int.
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
* Update DeflateStream.xml
Reverting these two changes too. There are no ReadSync/WriteSync functions in DeflateStream that receive byte[],int,int.
* Update BrotliStream.xml
Making sure all the "Consider using ReadAsync/WriteAsync" suggestions point to System.IO.Stream.
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
* Update xml/System.IO.Compression/BrotliStream.xml
Co-Authored-By: carlossanlop <[email protected]>
<paramname="compressionLevel">To be added.</param>
39
-
<summary>To be added.</summary>
37
+
<paramname="stream">The stream to compress.</param>
38
+
<paramname="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
39
+
<summary>Initializes a new instance of the <seecref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level.</summary>
<paramname="stream">The stream to compress.</param>
60
+
<paramname="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
61
+
<summary>Initializes a new instance of the <seecref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression mode.</summary>
<paramname="compressionLevel">To be added.</param>
84
-
<paramname="leaveOpen">To be added.</param>
85
-
<summary>To be added.</summary>
82
+
<paramname="stream">The stream to compress.</param>
83
+
<paramname="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
84
+
<paramname="leaveOpen"><seelangword="true" /> to leave the stream open after disposing the <seecref="T:System.IO.Compression.BrotliStream" /> object; otherwise, <seelangword="false" />.</param>
85
+
<summary>Initializes a new instance of the <seecref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
<paramname="stream">The stream to compress.</param>
107
+
<paramname="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
108
108
<paramname="leaveOpen">To be added.</param>
109
-
<summary>To be added.</summary>
109
+
<summary>Initializes a new instance of the <seecref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
110
110
<remarks>To be added.</remarks>
111
111
</Docs>
112
112
</Member>
@@ -126,9 +126,10 @@
126
126
<ReturnType>System.IO.Stream</ReturnType>
127
127
</ReturnValue>
128
128
<Docs>
129
-
<summary>To be added.</summary>
130
-
<value>To be added.</value>
129
+
<summary>Gets a reference to the underlying stream.</summary>
130
+
<value>A stream object that represents the underlying stream.</value>
131
131
<remarks>To be added.</remarks>
132
+
<exceptioncref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
<paramname="buffer">The buffer from which data will be read.</param>
158
+
<paramname="offset">The byte offset in <paramrefname="array" /> at which to begin reading data from the stream.</param>
159
+
<paramname="count">To maximum number of bytes to read.</param>
160
+
<paramname="asyncCallback">An optional asynchronous callback, to be called when the read operation is complete.</param>
161
+
<paramname="asyncState">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
162
+
<summary>Begins an asynchronous read operation. (Consider using the <seecref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
163
+
<returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
163
164
<remarks>To be added.</remarks>
165
+
<exceptioncref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
166
+
<exceptioncref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
167
+
<exceptioncref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
168
+
<exceptioncref="T:System.NotSupportedException">The current <seecref="T:System.IO.Compression.BrotliStream" /> implementation does not support the read operation.</exception>
169
+
<exceptioncref="T:System.InvalidOperationException">This call cannot be completed.</exception>
<paramname="buffer">The buffer from which data will be written.</param>
195
+
<paramname="offset">The byte offset in <paramrefname="array" /> at which to begin writing data from the stream.</param>
196
+
<paramname="count">The maximum number of bytes to write.</param>
197
+
<paramname="asyncCallback">An optional asynchronous callback, to be called when the write operation is complete.</param>
198
+
<paramname="asyncState">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
199
+
<summary>Begins an asynchronous write operation. (Consider using the <seecref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
200
+
<returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
195
201
<remarks>To be added.</remarks>
202
+
<exceptioncref="T:System.IO.IOException">The method tried to write asynchronously past the end of the stream, or a disk error occurred.</exception>
203
+
<exceptioncref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
204
+
<exceptioncref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
205
+
<exceptioncref="T:System.NotSupportedException">The current <seecref="T:System.IO.Compression.BrotliStream" /> implementation does not support the write operation.</exception>
206
+
<exceptioncref="T:System.InvalidOperationException">The write operation cannot be performed because the stream is closed.</exception>
196
207
</Docs>
197
208
</Member>
198
209
<MemberMemberName="CanRead">
@@ -211,8 +222,8 @@
211
222
<ReturnType>System.Boolean</ReturnType>
212
223
</ReturnValue>
213
224
<Docs>
214
-
<summary>To be added.</summary>
215
-
<value>To be added.</value>
225
+
<summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
226
+
<value><seelangword="true" /> if the <seecref="T:System.IO.Compression.CompressionMode" /> value is <seelangword="Decompress," /> and the underlying stream supports reading and is not closed; otherwise, <seelangword="false" />.</value>
216
227
<remarks>To be added.</remarks>
217
228
</Docs>
218
229
</Member>
@@ -232,8 +243,8 @@
232
243
<ReturnType>System.Boolean</ReturnType>
233
244
</ReturnValue>
234
245
<Docs>
235
-
<summary>To be added.</summary>
236
-
<value>To be added.</value>
246
+
<summary>Gets a value indicating whether the stream supports seeking.</summary>
247
+
<value><seelangword="false" /> in all cases.</value>
237
248
<remarks>To be added.</remarks>
238
249
</Docs>
239
250
</Member>
@@ -253,8 +264,8 @@
253
264
<ReturnType>System.Boolean</ReturnType>
254
265
</ReturnValue>
255
266
<Docs>
256
-
<summary>To be added.</summary>
257
-
<value>To be added.</value>
267
+
<summary>Gets a value indicating whether the stream supports writing.</summary>
268
+
<value><seelangword="true" /> if the <seecref="T:System.IO.Compression.CompressionMode" /> value is <seelangword="Compress" />, and the underlying stream supports writing and is not closed; otherwise, <seelangword="false" />.</value>
<paramname="disposing"><seelangword="true" /> to release both managed and unmanaged resources; <seelangword="false" /> to release only unmanaged resources.</param>
292
+
<summary>Releases the unmanaged resources used by the <seecref="T:System.IO.Compression.BrotliStream" /> and optionally releases the managed resources.</summary>
<paramname="asyncResult">The reference to the pending asynchronous request to finish.</param>
338
+
<summary>Waits for the pending asynchronous read to complete. (Consider using the <seecref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
339
+
<returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <seecref="T:System.IO.Compression.BrotliStream" /> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
329
340
<remarks>To be added.</remarks>
341
+
<exceptioncref="T:System.ArgumentNullException"><paramrefname="asyncResult" /> is <seelangword="null" />.</exception>
342
+
<exceptioncref="T:System.ArgumentException"><paramrefname="asyncResult" /> did not originate from a <seecref="M:System.IO.Compression.BrotliStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> method on the current stream.</exception>
343
+
<exceptioncref="T:System.InvalidOperationException">The end operation cannot be performed because the stream is closed.</exception>
<paramname="asyncResult">The object that represents the asynchronous call.</param>
366
+
<summary>Handles the end of an asynchronous write operation. (Consider using the <seecref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
353
367
<remarks>To be added.</remarks>
368
+
<exceptioncref="T:System.InvalidOperationException">The underlying stream is closed or <seelangword="null" />.</exception>
354
369
</Docs>
355
370
</Member>
356
371
<MemberMemberName="Flush">
@@ -370,7 +385,7 @@
370
385
</ReturnValue>
371
386
<Parameters />
372
387
<Docs>
373
-
<summary>To be added.</summary>
388
+
<summary>The current implementation of this method has no functionality.</summary>
374
389
<remarks>To be added.</remarks>
375
390
</Docs>
376
391
</Member>
@@ -414,9 +429,10 @@
414
429
<ReturnType>System.Int64</ReturnType>
415
430
</ReturnValue>
416
431
<Docs>
417
-
<summary>To be added.</summary>
418
-
<value>To be added.</value>
432
+
<summary>This property is not supported and always throws a <seecref="T:System.NotSupportedException" />.</summary>
433
+
<value>A long value.</value>
419
434
<remarks>To be added.</remarks>
435
+
<exceptioncref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
420
436
</Docs>
421
437
</Member>
422
438
<MemberMemberName="Position">
@@ -435,9 +451,10 @@
435
451
<ReturnType>System.Int64</ReturnType>
436
452
</ReturnValue>
437
453
<Docs>
438
-
<summary>To be added.</summary>
439
-
<value>To be added.</value>
454
+
<summary>This property is not supported and always throws a <seecref="T:System.NotSupportedException" />.</summary>
455
+
<value>A long value.</value>
440
456
<remarks>To be added.</remarks>
457
+
<exceptioncref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
441
458
</Docs>
442
459
</Member>
443
460
<MemberMemberName="Read">
@@ -486,12 +503,18 @@
486
503
<ParameterName="count"Type="System.Int32" />
487
504
</Parameters>
488
505
<Docs>
489
-
<paramname="buffer">To be added.</param>
490
-
<paramname="offset">To be added.</param>
491
-
<paramname="count">To be added.</param>
492
-
<summary>To be added.</summary>
493
-
<returns>To be added.</returns>
506
+
<paramname="buffer">The array used to store decompressed bytes.</param>
507
+
<paramname="offset">The byte offset in <paramrefname="buffer" /> at which the read bytes will be placed.</param>
508
+
<paramname="count">The maximum number of decompressed bytes to read.</param>
509
+
<summary>Reads a number of decompressed bytes into the specified byte array.</summary>
510
+
<returns>The number of bytes that were decompressed into the byte array. If the end of the stream has been reached, zero or the number of bytes read is returned.</returns>
494
511
<remarks>To be added.</remarks>
512
+
<exceptioncref="T:System.ArgumentNullException"><paramrefname="buffer" /> is <seelangword="null" />.</exception>
513
+
<exceptioncref="T:System.InvalidOperationException">The <seecref="T:System.IO.Compression.CompressionMode" /> value was <seelangword="Compress" /> when the object was created, or there is already an active asynchronous operation on this stream.</exception>
514
+
<exceptioncref="T:System.ArgumentOutOfRangeException"><paramrefname="offset" /> or <paramrefname="count" /> is less than zero.</exception>
515
+
<exceptioncref="T:System.ArgumentException">The <paramrefname="buffer" /> length minus the index starting point is less than <paramrefname="count" />.</exception>
516
+
<exceptioncref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
517
+
<exceptioncref="T:System.ObjectDisposedException">The underlying stream is null or closed.</exception>
0 commit comments