Skip to content

Commit 1616d87

Browse files
authored
Un-encode characters in xref links (Numerics/Collections/Buffers/Globalization/ComponentModel) (#12461)
1 parent 058f3ff commit 1616d87

430 files changed

Lines changed: 8541 additions & 8541 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

xml/System.Buffers/ArrayBufferWriter`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ You must clear the <xref:System.Buffers.ArrayBufferWriter`1> before trying to re
314314
<returns>A <see cref="T:System.Memory`1" /> whose length is at least <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
315315
<remarks>
316316
<format type="text/markdown"><![CDATA[
317-
This method never returns <xref:System.Memory%601.Empty?displayProperty=nameWithType>.
317+
This method never returns <xref:System.Memory`1.Empty?displayProperty=nameWithType>.
318318
]]></format>
319319
</remarks>
320320
<exception cref="T:System.ArgumentException">
@@ -366,7 +366,7 @@ This method never returns <xref:System.Memory%601.Empty?displayProperty=nameWith
366366
<returns>A span of at least <paramref name="sizeHint" /> in length. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
367367
<remarks>
368368
<format type="text/markdown"><![CDATA[
369-
This method never returns <xref:System.Span%601.Empty?displayProperty=nameWithType>.
369+
This method never returns <xref:System.Span`1.Empty?displayProperty=nameWithType>.
370370
]]></format>
371371
</remarks>
372372
<exception cref="T:System.ArgumentException">

xml/System.Buffers/ArrayPool`1.xml

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@
6868
<typeparam name="T">The type of the objects that are in the resource pool.</typeparam>
6969
<summary>Provides a resource pool that enables reusing instances of type T[].</summary>
7070
<remarks>
71-
<format type="text/markdown"><![CDATA[
72-
73-
## Remarks
74-
75-
Using the <xref:System.Buffers.ArrayPool%601> class to rent and return buffers (using the <xref:System.Buffers.ArrayPool%601.Rent%2A> and <xref:System.Buffers.ArrayPool%601.Return%2A> methods) can improve performance in situations where arrays are created and destroyed frequently, resulting in significant memory pressure on the garbage collector.
76-
71+
<format type="text/markdown"><![CDATA[
72+
73+
## Remarks
74+
75+
Using the <xref:System.Buffers.ArrayPool`1> class to rent and return buffers (using the <xref:System.Buffers.ArrayPool`1.Rent*> and <xref:System.Buffers.ArrayPool`1.Return*> methods) can improve performance in situations where arrays are created and destroyed frequently, resulting in significant memory pressure on the garbage collector.
76+
7777
]]></format>
7878
</remarks>
7979
<threadsafe>This class is thread-safe. All members may be used by multiple threads concurrently.</threadsafe>
@@ -113,11 +113,11 @@
113113
<Docs>
114114
<summary>Initializes a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class.</summary>
115115
<remarks>
116-
<format type="text/markdown"><![CDATA[
117-
118-
## Remarks
119-
120-
Note that this constructor is protected; it can only be called by classes derived from the <xref:System.Buffers.ArrayPool%601> class.
116+
<format type="text/markdown"><![CDATA[
117+
118+
## Remarks
119+
120+
Note that this constructor is protected; it can only be called by classes derived from the <xref:System.Buffers.ArrayPool`1> class.
121121
]]></format>
122122
</remarks>
123123
</Docs>
@@ -208,11 +208,11 @@ Note that this constructor is protected; it can only be called by classes derive
208208
<summary>Creates a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class using the specified configuration.</summary>
209209
<returns>A new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class with the specified configuration.</returns>
210210
<remarks>
211-
<format type="text/markdown"><![CDATA[
212-
213-
## Remarks
214-
215-
The instance of the <xref:System.Buffers.ArrayPool%601> class created by this method will group arrays into buckets, with no more than `maxArraysPerBucket` in each bucket, and with those arrays not exceeding `maxArrayLength` in length.
211+
<format type="text/markdown"><![CDATA[
212+
213+
## Remarks
214+
215+
The instance of the <xref:System.Buffers.ArrayPool`1> class created by this method will group arrays into buckets, with no more than `maxArraysPerBucket` in each bucket, and with those arrays not exceeding `maxArrayLength` in length.
216216
]]></format>
217217
</remarks>
218218
</Docs>
@@ -259,13 +259,13 @@ The instance of the <xref:System.Buffers.ArrayPool%601> class created by this me
259259
<summary>Retrieves a buffer that is at least the requested length.</summary>
260260
<returns>An array of type T that is at least <paramref name="minimumLength" /> in length.</returns>
261261
<remarks>
262-
<format type="text/markdown"><![CDATA[
263-
264-
## Remarks
262+
<format type="text/markdown"><![CDATA[
263+
264+
## Remarks
265265
266-
This buffer is loaned to the caller and should be returned to the same pool using the <xref:System.Buffers.ArrayPool%601.Return%2A> method, so that it can be reused in subsequent calls to the <xref:System.Buffers.ArrayPool%601.Rent%2A> method. Failure to return a rented buffer is not a fatal error. However, it may lead to decreased application performance, as the pool may need to create a new buffer to replace the lost one.
266+
This buffer is loaned to the caller and should be returned to the same pool using the <xref:System.Buffers.ArrayPool`1.Return*> method, so that it can be reused in subsequent calls to the <xref:System.Buffers.ArrayPool`1.Rent*> method. Failure to return a rented buffer is not a fatal error. However, it may lead to decreased application performance, as the pool may need to create a new buffer to replace the lost one.
267267
268-
The array returned by this method may not be zero-initialized.
268+
The array returned by this method may not be zero-initialized.
269269
]]></format>
270270
</remarks>
271271
</Docs>
@@ -312,11 +312,11 @@ The array returned by this method may not be zero-initialized.
312312
<param name="clearArray">Indicates whether the contents of the buffer should be cleared before reuse. If <paramref name="clearArray" /> is set to <see langword="true" />, and if the pool will store the buffer to enable subsequent reuse, the <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)" /> method will clear the <paramref name="array" /> of its contents so that a subsequent caller using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)" /> method will not see the content of the previous caller. If <paramref name="clearArray" /> is set to <see langword="false" /> or if the pool will release the buffer, the array's contents are left unchanged.</param>
313313
<summary>Returns an array to the pool that was previously obtained using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)" /> method on the same <see cref="T:System.Buffers.ArrayPool`1" /> instance.</summary>
314314
<remarks>
315-
<format type="text/markdown"><![CDATA[
316-
317-
## Remarks
315+
<format type="text/markdown"><![CDATA[
318316
319-
Once a buffer has been returned to the pool, the caller gives up all ownership of the buffer and must not use it. The reference returned from a given call to the <xref:System.Buffers.ArrayPool%601.Rent%2A> method must only be returned using the <xref:System.Buffers.ArrayPool%601.Return%2A> method once. The default <xref:System.Buffers.ArrayPool%601> may hold onto the returned buffer in order to rent it again, or it may release the returned buffer if it's determined that the pool already has enough buffers stored.
317+
## Remarks
318+
319+
Once a buffer has been returned to the pool, the caller gives up all ownership of the buffer and must not use it. The reference returned from a given call to the <xref:System.Buffers.ArrayPool`1.Rent*> method must only be returned using the <xref:System.Buffers.ArrayPool`1.Return*> method once. The default <xref:System.Buffers.ArrayPool`1> may hold onto the returned buffer in order to rent it again, or it may release the returned buffer if it's determined that the pool already has enough buffers stored.
320320
321321
> [!IMPORTANT]
322322
> Returning the same array reference twice or continuing to use the array reference after it has been returned is a high-severity security issue. These actions can lead to [double-free](https://cwe.mitre.org/data/definitions/415.html) and [use-after-free](https://cwe.mitre.org/data/definitions/416.html) vulnerabilities, which might result in data corruption, data leaks, and denial of service.
@@ -362,11 +362,11 @@ Once a buffer has been returned to the pool, the caller gives up all ownership o
362362
<summary>Gets a shared <see cref="T:System.Buffers.ArrayPool`1" /> instance.</summary>
363363
<value>A shared <see cref="T:System.Buffers.ArrayPool`1" /> instance.</value>
364364
<remarks>
365-
<format type="text/markdown"><![CDATA[
366-
367-
## Remarks
365+
<format type="text/markdown"><![CDATA[
366+
367+
## Remarks
368368
369-
The shared pool provides a default implementation of the <xref:System.Buffers.ArrayPool%601> 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 <xref:System.Buffers.ArrayPool%601.Rent%2A> 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.
369+
The shared pool provides a default implementation of the <xref:System.Buffers.ArrayPool`1> 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 <xref:System.Buffers.ArrayPool`1.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.
370370
]]></format>
371371
</remarks>
372372
</Docs>

xml/System.Buffers/IBufferWriter`1.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,11 @@
124124
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size (specified by <paramref name="sizeHint" />).</summary>
125125
<returns>A <see cref="T:System.Memory`1" /> of at least the size <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer.</returns>
126126
<remarks>
127-
<format type="text/markdown"><![CDATA[
127+
<format type="text/markdown"><![CDATA[
128128
129129
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
130130
131-
This must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
131+
This must never return <xref:System.Span`1.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
132132
133133
You must request a new buffer after calling `Advance` to continue writing more data; you cannot write to a previously acquired buffer.
134134
@@ -179,10 +179,10 @@ You must request a new buffer after calling `Advance` to continue writing more d
179179
<returns>A <see cref="T:System.Span`1" /> of at least the size <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer.</returns>
180180
<remarks>
181181
<format type="text/markdown"><![CDATA[
182-
182+
183183
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
184184
185-
This method must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
185+
This method must never return <xref:System.Span`1.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
186186
187187
You must request a new buffer after calling `Advance` to continue writing more data; you cannot write to a previously acquired buffer.
188188
]]></format>

xml/System.Buffers/IMemoryOwner`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@
6767
<typeparam name="T">The type of elements to store in memory.</typeparam>
6868
<summary>Identifies the owner of a block of memory who is responsible for disposing of the underlying memory appropriately. </summary>
6969
<remarks>
70-
<format type="text/markdown"><![CDATA[
70+
<format type="text/markdown"><![CDATA[
7171
72-
The `IMemoryOwner<T>` interface is used to define the owner responsible for the lifetime management of a <xref:System.Memory%601> buffer. An instance of the `IMemoryOwner<T>` interface is returned by the <xref:System.Buffers.MemoryPool%601.Rent%2A?displayProperty=nameWithType> method.
72+
The `IMemoryOwner<T>` interface is used to define the owner responsible for the lifetime management of a <xref:System.Memory`1> buffer. An instance of the `IMemoryOwner<T>` interface is returned by the <xref:System.Buffers.MemoryPool`1.Rent*?displayProperty=nameWithType> method.
7373
7474
While a buffer can have multiple consumers, it can only have a single owner at any given time. The owner can:
7575
@@ -79,7 +79,7 @@ While a buffer can have multiple consumers, it can only have a single owner at a
7979
8080
- Destroy the buffer when it is no longer in use.
8181
82-
Because the `IMemoryOwner<T>` object implements the <xref:System.IDisposable> interface, you should call its <xref:System.IDisposable.Dispose%2A> method only after the memory buffer is no longer needed and you have destroyed it. You should *not* dispose of the `IMemoryOwner<T>` object while a reference to its memory is available. This means that the type in which `IMemoryOwner<T>` is declared should not have a <xref:System.Object.Finalize%2A> method.
82+
Because the `IMemoryOwner<T>` object implements the <xref:System.IDisposable> interface, you should call its <xref:System.IDisposable.Dispose*> method only after the memory buffer is no longer needed and you have destroyed it. You should *not* dispose of the `IMemoryOwner<T>` object while a reference to its memory is available. This means that the type in which `IMemoryOwner<T>` is declared should not have a <xref:System.Object.Finalize*> method.
8383
8484
]]></format>
8585
</remarks>

xml/System.Buffers/IPinnable.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@
5252
<Docs>
5353
<summary>Provides a mechanism for pinning and unpinning objects to prevent the garbage collector from moving them.</summary>
5454
<remarks>
55-
<format type="text/markdown"><![CDATA[
56-
57-
## Remarks
55+
<format type="text/markdown"><![CDATA[
5856
59-
The <xref:System.Buffers.MemoryManager%601> class implements the `IPinnable` interface.
57+
## Remarks
58+
59+
The <xref:System.Buffers.MemoryManager`1> class implements the `IPinnable` interface.
6060
6161
]]></format>
6262
</remarks>
@@ -104,11 +104,11 @@ The <xref:System.Buffers.MemoryManager%601> class implements the `IPinnable` int
104104
<summary>Pins a block of memory.</summary>
105105
<returns>A handle to the block of memory.</returns>
106106
<remarks>
107-
<format type="text/markdown"><![CDATA[
108-
109-
## Remarks
107+
<format type="text/markdown"><![CDATA[
108+
109+
## Remarks
110110
111-
A developer can access an object that implements the <xref:System.Buffers.IPinnable> interface without pinning it only through managed APIs. Pinning is required for access by unmanaged APIs.
111+
A developer can access an object that implements the <xref:System.Buffers.IPinnable> interface without pinning it only through managed APIs. Pinning is required for access by unmanaged APIs.
112112
113113
Call this method to indicate that the <xref:System.Buffers.IPinnable> object cannot be moved by the garbage collector so that the address of the pinned object can be used.
114114
@@ -155,9 +155,9 @@ Call this method to indicate that the <xref:System.Buffers.IPinnable> object can
155155
<Docs>
156156
<summary>Frees a block of pinned memory.</summary>
157157
<remarks>
158-
<format type="text/markdown"><![CDATA[
159-
160-
## Remarks
158+
<format type="text/markdown"><![CDATA[
159+
160+
## Remarks
161161
162162
Call this method to indicate that the <xref:System.Buffers.IPinnable> object no longer needs to be pinned, and that the garbage collector can now move the object.
163163

xml/System.Buffers/MemoryHandle.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@
6464
6565
A `MemoryHandle` instance represents a handle to a pinned block of memory. It is returned by the following methods:
6666
67-
- <xref:System.Buffers.IPinnable.Pin%2A?displayProperty=nameWithType>.
68-
- <xref:System.Memory%601.Pin%2A?displayProperty=nameWithType>
69-
- <xref:System.ReadOnlyMemory%601.Pin%2A?displayProperty=nameWithType>.
70-
- <xref:System.Buffers.MemoryManager%601.Pin%2A?displayProperty=nameWithType>
67+
- <xref:System.Buffers.IPinnable.Pin*?displayProperty=nameWithType>.
68+
- <xref:System.Memory`1.Pin*?displayProperty=nameWithType>
69+
- <xref:System.ReadOnlyMemory`1.Pin*?displayProperty=nameWithType>.
70+
- <xref:System.Buffers.MemoryManager`1.Pin*?displayProperty=nameWithType>
7171
7272
]]></format>
7373
</remarks>

xml/System.Buffers/MemoryManager`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@
7575
<typeparam name="T">The type of items in the memory buffer managed by this memory manager.</typeparam>
7676
<summary>An abstract base class that is used to replace the implementation of <see cref="T:System.Memory`1" />.</summary>
7777
<remarks>
78-
<format type="text/markdown"><![CDATA[
78+
<format type="text/markdown"><![CDATA[
7979
80-
The `MemoryManager<T>` class is used to extend the knowledge of types that <xref:System.Memory%601> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <xref:System.Memory%601> to be backed by a <xref:System.Runtime.InteropServices.SafeHandle>.
80+
The `MemoryManager<T>` class is used to extend the knowledge of types that <xref:System.Memory`1> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <xref:System.Memory`1> to be backed by a <xref:System.Runtime.InteropServices.SafeHandle>.
8181
8282
> [!NOTE]
8383
> The `MemoryManager<T>` class is intended for advanced scenarios. Most developers do not need to use it.

0 commit comments

Comments
 (0)