Skip to content

Commit 892bcc5

Browse files
authored
Merge pull request #8464 from dakersnar/fix-72402
Fix api documentation for System.Runtime.Intrinsics
2 parents b84d718 + a0bf75a commit 892bcc5

File tree

8 files changed

+35
-39
lines changed

8 files changed

+35
-39
lines changed

xml/System.Numerics/Vector.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
</Base>
3636
<Interfaces />
3737
<Docs>
38-
<summary>Provides a collection of static convenience methods for creating, manipulating, combining, and converting generic vectors.</summary>
38+
<summary>Provides a collection of static methods for creating, manipulating, and otherwise operating on generic vectors.</summary>
3939
<remarks>To be added.</remarks>
4040
</Docs>
4141
<Members>

xml/System.Numerics/Vector`1.xml

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
</Attribute>
5858
</Attributes>
5959
<Docs>
60-
<typeparam name="T">The vector type. <c>T</c> can be any primitive numeric type.</typeparam>
60+
<typeparam name="T">The type of the elements in the vector. <typeparamref name="T" /> can be any primitive numeric type.</typeparam>
6161
<summary>Represents a single vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms.</summary>
6262
<remarks>
6363
<format type="text/markdown"><![CDATA[
@@ -67,21 +67,8 @@
6767
6868
The <xref:System.Numerics.Vector%601> structure provides support for hardware acceleration.
6969
70-
The term *primitive numeric data type* in this article refers to numeric data types that are directly supported by the CPU and have instructions that can manipulate those data types. The following table shows which primitive numeric data type and operation combination uses intrinsic instructions for faster execution:
70+
The term *primitive numeric data type* in this article refers to numeric data types that are directly supported by the CPU and have instructions that can manipulate those data types.
7171
72-
| Primitive type | `+` | `-` | `*` | `/` |
73-
| --- | :---: | :---: | :---: | :---: |
74-
|`sbyte` | Yes | Yes | No | No |
75-
|`byte` | Yes | Yes | No | No |
76-
|`short` | Yes | Yes | Yes | No |
77-
|`ushort` | Yes | Yes | No | No |
78-
| `int` | Yes | Yes | Yes | No |
79-
| `uint` | Yes | Yes | No | No |
80-
| `long` | Yes | Yes | No | No |
81-
| `ulong` | Yes | Yes | No | No |
82-
| `float` | Yes | Yes | Yes | Yes |
83-
| `double` | Yes | Yes | Yes | Yes |
84-
8572
]]></format>
8673
</remarks>
8774
</Docs>

xml/System.Runtime.Intrinsics/Vector128.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<summary>Provides a collection of static methods for creating, manipulating, and otherwise operating on 128-bit vectors.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -2838,7 +2838,7 @@ On x86, this method corresponds to __m128i _mm_setr_epi8
28382838
<Parameter Name="value" Type="T" Index="0" FrameworkAlternate="net-7.0" />
28392839
</Parameters>
28402840
<Docs>
2841-
<typeparam name="T">To be added.</typeparam>
2841+
<typeparam name="T">The type of the elements in the vector.</typeparam>
28422842
<param name="value">The value that all elements will be initialized to.</param>
28432843
<summary>Creates a new <see cref="T:System.Runtime.Intrinsics.Vector128`1" /> instance with all elements initialized to the specified value.</summary>
28442844
<returns>A new <see cref="T:System.Runtime.Intrinsics.Vector128`1" /> with all elements initialized to <paramref name="value" />.</returns>
@@ -6723,7 +6723,7 @@ This method may bypass the cache on certain platforms.
67236723
<Parameter Name="destination" Type="System.Span&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
67246724
</Parameters>
67256725
<Docs>
6726-
<typeparam name="T">To be added.</typeparam>
6726+
<typeparam name="T">The type of the input vector.</typeparam>
67276727
<param name="vector">The vector to copy.</param>
67286728
<param name="destination">The span to which <paramref name="destination" /> is copied.</param>
67296729
<summary>Tries to copy a <see cref="T:System.Numerics.Vector`1" /> to a given span.</summary>

xml/System.Runtime.Intrinsics/Vector128`1.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
</Attribute>
3838
</Attributes>
3939
<Docs>
40-
<typeparam name="T">To be added.</typeparam>
41-
<summary>To be added.</summary>
40+
<typeparam name="T">The type of the elements in the vector.</typeparam>
41+
<summary>Represents a 128-bit vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms.</summary>
4242
<remarks>To be added.</remarks>
4343
</Docs>
4444
<Members>
@@ -232,10 +232,13 @@
232232
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
233233
</Parameters>
234234
<Docs>
235-
<param name="index">To be added.</param>
236-
<summary>To be added.</summary>
237-
<value>To be added.</value>
235+
<param name="index">The index of the element to get.</param>
236+
<summary>Gets the element at the specified index.</summary>
237+
<value>The value of the element at <paramref name="index" />.</value>
238238
<remarks>To be added.</remarks>
239+
<exception cref="T:System.ArgumentOutOfRangeException">
240+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
241+
<exception cref="T:System.NotSupportedException">The type of the vector (<typeparamref name="T" />) is not supported.</exception>
239242
</Docs>
240243
</Member>
241244
<Member MemberName="op_Addition">

xml/System.Runtime.Intrinsics/Vector256.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<summary>Provides a collection of static methods for creating, manipulating, and otherwise operating on 256-bit vectors.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -6623,7 +6623,7 @@ This method may bypass the cache on certain platforms.
66236623
<Parameter Name="destination" Type="System.Span&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
66246624
</Parameters>
66256625
<Docs>
6626-
<typeparam name="T">To be added.</typeparam>
6626+
<typeparam name="T">The type of the input vector.</typeparam>
66276627
<param name="vector">The vector to copy.</param>
66286628
<param name="destination">The span to which <paramref name="destination" /> is copied.</param>
66296629
<summary>Tries to copy a <see cref="T:System.Numerics.Vector`1" /> to a given span.</summary>

xml/System.Runtime.Intrinsics/Vector256`1.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
</Attribute>
3838
</Attributes>
3939
<Docs>
40-
<typeparam name="T">To be added.</typeparam>
41-
<summary>To be added.</summary>
40+
<typeparam name="T">The type of the elements in the vector.</typeparam>
41+
<summary>Represents a 256-bit vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms.</summary>
4242
<remarks>To be added.</remarks>
4343
</Docs>
4444
<Members>
@@ -232,10 +232,13 @@
232232
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
233233
</Parameters>
234234
<Docs>
235-
<param name="index">To be added.</param>
236-
<summary>To be added.</summary>
237-
<value>To be added.</value>
235+
<param name="index">The index of the element to get.</param>
236+
<summary>Gets the element at the specified index.</summary>
237+
<value>The value of the element at <paramref name="index" />.</value>
238238
<remarks>To be added.</remarks>
239+
<exception cref="T:System.ArgumentOutOfRangeException">
240+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
241+
<exception cref="T:System.NotSupportedException">The type of the vector (<typeparamref name="T" />) is not supported.</exception>
239242
</Docs>
240243
</Member>
241244
<Member MemberName="op_Addition">

xml/System.Runtime.Intrinsics/Vector64.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<summary>Provides a collection of static methods for creating, manipulating, and otherwise operating on 64-bit vectors.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -2019,7 +2019,7 @@ On x86, this method corresponds to __m64 _mm_setr_pi8
20192019
<Parameter Name="value" Type="T" Index="0" FrameworkAlternate="net-7.0" />
20202020
</Parameters>
20212021
<Docs>
2022-
<typeparam name="T">To be added.</typeparam>
2022+
<typeparam name="T">The type of the elements in the vector.</typeparam>
20232023
<param name="value">The value that all elements will be initialized to.</param>
20242024
<summary>Creates a new <see cref="T:System.Runtime.Intrinsics.Vector64`1" /> instance with all elements initialized to the specified value.</summary>
20252025
<returns>A new <see cref="T:System.Runtime.Intrinsics.Vector64`1" /> with all elements initialized to <paramref name="value" />.</returns>
@@ -5638,7 +5638,7 @@ This method may bypass the cache on certain platforms.
56385638
<Parameter Name="destination" Type="System.Span&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
56395639
</Parameters>
56405640
<Docs>
5641-
<typeparam name="T">To be added.</typeparam>
5641+
<typeparam name="T">The type of the input vector.</typeparam>
56425642
<param name="vector">The vector to copy.</param>
56435643
<param name="destination">The span to which <paramref name="destination" /> is copied.</param>
56445644
<summary>Tries to copy a <see cref="T:System.Numerics.Vector`1" /> to a given span.</summary>

xml/System.Runtime.Intrinsics/Vector64`1.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
</Attribute>
3838
</Attributes>
3939
<Docs>
40-
<typeparam name="T">To be added.</typeparam>
41-
<summary>To be added.</summary>
40+
<typeparam name="T">The type of the elements in the vector.</typeparam>
41+
<summary>Represents a 64-bit vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms.</summary>
4242
<remarks>To be added.</remarks>
4343
</Docs>
4444
<Members>
@@ -232,10 +232,13 @@
232232
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
233233
</Parameters>
234234
<Docs>
235-
<param name="index">To be added.</param>
236-
<summary>To be added.</summary>
237-
<value>To be added.</value>
235+
<param name="index">The index of the element to get.</param>
236+
<summary>Gets the element at the specified index.</summary>
237+
<value>The value of the element at <paramref name="index" />.</value>
238238
<remarks>To be added.</remarks>
239+
<exception cref="T:System.ArgumentOutOfRangeException">
240+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
241+
<exception cref="T:System.NotSupportedException">The type of the vector (<typeparamref name="T" />) is not supported.</exception>
239242
</Docs>
240243
</Member>
241244
<Member MemberName="op_Addition">

0 commit comments

Comments
 (0)