|
17 | 17 | <Interfaces />
|
18 | 18 | <Docs>
|
19 | 19 | <typeparam name="T">The type of the objects that are in the resource pool.</typeparam>
|
20 |
| - <summary>Provides a resource pool that enables the reusing of instances of type <see cref="T:T[]"/>.</summary> |
| 20 | + <summary>Provides a resource pool that enables reusing instances of type <see cref="T:T[]"/>.</summary> |
21 | 21 | <remarks><format type="text/markdown"><![CDATA[
|
22 | 22 |
|
23 | 23 | ## Remarks
|
24 | 24 |
|
25 |
| - Using the <see cref="T:System.Buffers.ArrayPool{T}"/> class to rent and return buffers (using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> and <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)"/> methods) can increase performance in situations where arrays are created and destroyed frequently, resulting in significant memory pressure on the garbage collector. |
| 25 | + Using the <see cref="T:System.Buffers.ArrayPool{T}"/> class to rent and return buffers (using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> and <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)"/> methods) can improve performance in situations where arrays are created and destroyed frequently, resulting in significant memory pressure on the garbage collector. |
26 | 26 |
|
27 | 27 | This class is thread-safe. All members may be used by multiple threads concurrently.
|
28 | 28 | ]]></format>
|
|
88 | 88 | <Docs>
|
89 | 89 | <param name="maxArrayLength">The maximum length of an array instance that may be stored in the pool.</param>
|
90 | 90 | <param name="maxArraysPerBucket">The maximum number of array instances that may be stored in each bucket in the pool. The pool groups arrays of similar lengths into buckets for faster access.</param>
|
91 |
| - <summary>Creates a new instance of the <see cref="ArrayPool{T}"/> class using the specifed configuration options.</summary> |
92 |
| - <returns>A new instance of the <see cref="ArrayPool{T}"/> class with the specified configuration options.</returns> |
| 91 | + <summary>Creates a new instance of the <see cref="ArrayPool{T}"/> class using the specifed configuration.</summary> |
| 92 | + <returns>A new instance of the <see cref="ArrayPool{T}"/> class with the specified configuration.</returns> |
93 | 93 | <remarks>
|
94 | 94 | <format type="text/markdown"><![CDATA[
|
95 | 95 |
|
96 | 96 | ## Remarks
|
97 | 97 |
|
98 |
| -The instance of the <see cref="ArrayPool{T}"/> class created by this method will group arrays into buckets, with no more than <paramref name="maxArraysPerBucket"/> in each bucket and with those arrays not exceeding <paramref name="maxArrayLength"/> in length. |
| 98 | +The instance of the <see cref="ArrayPool{T}"/> class created by this method will group arrays into buckets, with no more than <paramref name="maxArraysPerBucket"/> in each bucket, and with those arrays not exceeding <paramref name="maxArrayLength"/> in length. |
99 | 99 | ]]></format>
|
100 | 100 | </remarks>
|
101 | 101 | </Docs>
|
@@ -185,7 +185,7 @@ Once a buffer has been returned to the pool, the caller gives up all ownership o
|
185 | 185 |
|
186 | 186 | ## Remarks
|
187 | 187 |
|
188 |
| -The shared pool provides a default implementation of the <see cref="ArrayPool{T}"/> class that's intended for general applicability. A shared class maintains arrays of multiple sizes, and may hand back a larger array than was actually requested, but will never hand back a smaller array than was requested. Renting a buffer from a shared class using the <see cref="Rent"/> method will result in an existing buffer being taken from the pool if an appropriate buffer is available or in a new buffer being allocated if one is not available. |
| 188 | +The shared pool provides a default implementation of the <see cref="ArrayPool{T}"/> class that's intended for general applicability. A shared class maintains arrays of multiple sizes, and may hand back a larger array than was actually requested, but it will never hand back a smaller array than was requested. Renting a buffer from a shared class using the <see cref="Rent"/> method will result in an existing buffer being taken from the pool if an appropriate buffer is available or in a new buffer being allocated if one is not available. |
189 | 189 | ]]></format>
|
190 | 190 | </remarks>
|
191 | 191 | </Docs>
|
|
0 commit comments