Skip to content

Commit eb235b6

Browse files
committed
Addressed review questions.
1 parent 1f116f9 commit eb235b6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

xml/System.Buffers/ArrayPool`1.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
## Remarks
2424
2525
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-
27-
This class is thread-safe. All members may be used by multiple threads concurrently.
26+
2827
]]></format>
2928
</remarks>
29+
<threadsafe>This class is thread-safe. All members may be used by multiple threads concurrently.</threadsafe>
3030
</Docs>
3131
<Members>
3232
<Member MemberName=".ctor">
@@ -42,8 +42,8 @@
4242
</AssemblyInfo>
4343
<Parameters />
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<remarks>To be added.</remarks>
45+
<summary>Invokes the static constructor when a new instance of the <see cref="ArrayPool{T}"/> class is instantiated.</summary>
46+
<remarks></remarks>
4747
</Docs>
4848
</Member>
4949
<Member MemberName="Create">
@@ -151,7 +151,7 @@ This buffer is loaned to the caller and should be returned to the same pool usin
151151
</Parameters>
152152
<Docs>
153153
<param name="array">A buffer to return to the pool that was previously obtained using the <see cref="Rent"/> method.</param>
154-
<param name="clearArray">Indicates whether the contents of the buffer should be cleared before reuse. If <paramref name="bufferLength"/> is set to <see langword="true" />, and if the pool will store the buffer to enable subsequent reuse, the <see cref="Return"/> method will clear the <paramref name="array"/> of its contents so that a subsequent consumer using the <see cref="Rent"/> method will not see the previous consumer's content. If <paramref name="bufferLength"/> is set to <see langword="false" /> or if the pool will release the buffer, the array's contents are left unchanged.</param>
154+
<param name="clearArray">Indicates whether the contents of the buffer should be cleared before reuse. If <paramref name="bufferLength"/> is set to <see langword="true" />, and if the pool will store the buffer to enable subsequent reuse, the <see cref="Return"/> method will clear the <paramref name="array"/> of its contents so that a subsequent caller using the <see cref="Rent"/> method will not see the content of the previous caller. If <paramref name="bufferLength"/> is set to <see langword="false" /> or if the pool will release the buffer, the array's contents are left unchanged.</param>
155155
<summary>Returns an array to the pool that was previously obtained using the <see cref="Rent"/> method on the same <see cref="ArrayPool{T}"/> instance.</summary>
156156
<remarks>
157157
<format type="text/markdown"><![CDATA[

0 commit comments

Comments
 (0)