Skip to content

Commit 1398870

Browse files
tannergoodingtannergooding
committed
Updating the documentation for System.Runtime.Intrinsics
1 parent cd4c83e commit 1398870

Some content is hidden

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

85 files changed

+10340
-2766
lines changed

‎xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml

Lines changed: 652 additions & 211 deletions
Large diffs are not rendered by default.

‎xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml

Lines changed: 441 additions & 147 deletions
Large diffs are not rendered by default.

‎xml/System.Runtime.Intrinsics.Arm/Aes+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Aes.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,10 @@
151151
<ReturnType>System.Boolean</ReturnType>
152152
</ReturnValue>
153153
<Docs>
154-
<summary>To be added.</summary>
155-
<value>To be added.</value>
156-
<remarks>To be added.</remarks>
154+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
155+
<value>
156+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
157+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
157158
</Docs>
158159
</Member>
159160
<Member MemberName="MixColumns">

‎xml/System.Runtime.Intrinsics.Arm/ArmBase+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
<Member MemberName="LeadingSignCount">

‎xml/System.Runtime.Intrinsics.Arm/ArmBase.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@
4848
<ReturnType>System.Boolean</ReturnType>
4949
</ReturnValue>
5050
<Docs>
51-
<summary>To be added.</summary>
52-
<value>To be added.</value>
53-
<remarks>To be added.</remarks>
51+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
52+
<value>
53+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
54+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
5455
</Docs>
5556
</Member>
5657
<Member MemberName="LeadingZeroCount">

‎xml/System.Runtime.Intrinsics.Arm/Crc32+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -110,9 +110,10 @@
110110
<ReturnType>System.Boolean</ReturnType>
111111
</ReturnValue>
112112
<Docs>
113-
<summary>To be added.</summary>
114-
<value>To be added.</value>
115-
<remarks>To be added.</remarks>
113+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
114+
<value>
115+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
116+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
116117
</Docs>
117118
</Member>
118119
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Crc32.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,10 @@
258258
<ReturnType>System.Boolean</ReturnType>
259259
</ReturnValue>
260260
<Docs>
261-
<summary>To be added.</summary>
262-
<value>To be added.</value>
263-
<remarks>To be added.</remarks>
261+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
262+
<value>
263+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
264+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
264265
</Docs>
265266
</Member>
266267
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Dp+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARMv8.2-DotProd hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Dp.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -516,9 +516,10 @@
516516
<ReturnType>System.Boolean</ReturnType>
517517
</ReturnValue>
518518
<Docs>
519-
<summary>To be added.</summary>
520-
<value>To be added.</value>
521-
<remarks>To be added.</remarks>
519+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
520+
<value>
521+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
522+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
522523
</Docs>
523524
</Member>
524525
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Rdm+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARMv8.1-RDMA hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
<Member MemberName="MultiplyRoundedDoublingAndAddSaturateHighScalar">

‎xml/System.Runtime.Intrinsics.Arm/Rdm.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@
4848
<ReturnType>System.Boolean</ReturnType>
4949
</ReturnValue>
5050
<Docs>
51-
<summary>To be added.</summary>
52-
<value>To be added.</value>
53-
<remarks>To be added.</remarks>
51+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
52+
<value>
53+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
54+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
5455
</Docs>
5556
</Member>
5657
<Member MemberName="MultiplyRoundedDoublingAndAddSaturateHigh">

‎xml/System.Runtime.Intrinsics.Arm/Sha1+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARM SHA1 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Sha1.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,10 @@
192192
<ReturnType>System.Boolean</ReturnType>
193193
</ReturnValue>
194194
<Docs>
195-
<summary>To be added.</summary>
196-
<value>To be added.</value>
197-
<remarks>To be added.</remarks>
195+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
196+
<value>
197+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
198+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
198199
</Docs>
199200
</Member>
200201
<Member MemberName="ScheduleUpdate0">

‎xml/System.Runtime.Intrinsics.Arm/Sha256+Arm64.xml

Lines changed: 5 additions & 4 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 access to the ARM SHA256 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,10 @@
4242
<ReturnType>System.Boolean</ReturnType>
4343
</ReturnValue>
4444
<Docs>
45-
<summary>To be added.</summary>
46-
<value>To be added.</value>
47-
<remarks>To be added.</remarks>
45+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
46+
<value>
47+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
48+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4849
</Docs>
4950
</Member>
5051
</Members>

‎xml/System.Runtime.Intrinsics.Arm/Sha256.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,10 @@
122122
<ReturnType>System.Boolean</ReturnType>
123123
</ReturnValue>
124124
<Docs>
125-
<summary>To be added.</summary>
126-
<value>To be added.</value>
127-
<remarks>To be added.</remarks>
125+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
126+
<value>
127+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
128+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
128129
</Docs>
129130
</Member>
130131
<Member MemberName="ScheduleUpdate0">

‎xml/System.Runtime.Intrinsics.Arm/Sve+Arm64.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Provides access to the ARM SVE hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -34,9 +34,10 @@
3434
<ReturnType>System.Boolean</ReturnType>
3535
</ReturnValue>
3636
<Docs>
37-
<summary>To be added.</summary>
38-
<value>To be added.</value>
39-
<remarks>To be added.</remarks>
37+
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
38+
<value>
39+
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
40+
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
4041
</Docs>
4142
</Member>
4243
</Members>

0 commit comments

Comments
 (0)