Skip to content

Updating the documentation for System.Runtime.Intrinsics #10275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Updating the documentation for System.Runtime.Intrinsics #10275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1398870
Updating the documentation for System.Runtime.Intrinsics
tannergooding Aug 19, 2024
7c766c4
Ensure that inheritdoc can be resolved
tannergooding Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
863 changes: 652 additions & 211 deletions xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml
View file
Open in desktop

Large diffs are not rendered by default.

588 changes: 441 additions & 147 deletions xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Aes+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Aes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="MixColumns">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/ArmBase+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="LeadingSignCount">
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/ArmBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="LeadingZeroCount">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Crc32+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -110,9 +110,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Crc32.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Dp+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARMv8.2-DotProd hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Dp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,9 +516,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Rdm+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARMv8.1-RDMA hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="MultiplyRoundedDoublingAndAddSaturateHighScalar">
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Rdm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="MultiplyRoundedDoublingAndAddSaturateHigh">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Sha1+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM SHA1 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Sha1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="ScheduleUpdate0">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Sha256+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM SHA256 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Runtime.Intrinsics.Arm/Sha256.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
<Member MemberName="ScheduleUpdate0">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Runtime.Intrinsics.Arm/Sve+Arm64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides access to the ARM SVE hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,9 +34,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
<value>
<see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
<remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="T:System.PlatformNotSupportedException" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading