Skip to content

Automatically port System.Runtime.Intrinsics.X86 triple slash comments #3095

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 10 commits into from
Sep 6, 2019
Merged

Automatically port System.Runtime.Intrinsics.X86 triple slash comments #3095

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3fee0a7
Automatically port System.Runtime.Intrinsics.X86
carlossanlop Aug 27, 2019
a09ef2d
remove BOM character
mairaw Aug 28, 2019
6897d91
remove BOM character
mairaw Aug 28, 2019
de1a462
remove BOM character
mairaw Aug 28, 2019
e1a2a93
remove BOM character
mairaw Aug 28, 2019
ea2cac4
test para tags
mairaw Aug 28, 2019
a63a0f5
Forced endline and spacing in function summaries. Moved explanations …
carlossanlop Aug 29, 2019
315646d
Test nbsp to force space
carlossanlop Aug 30, 2019
01a4187
Testing <para> and &#160;
carlossanlop Sep 3, 2019
ec85bc0
Remove &#160;, leave only <para></para>
carlossanlop Sep 5, 2019
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
174 changes: 156 additions & 18 deletions xml/System.Runtime.Intrinsics.X86/Avx2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3617,7 +3617,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXBW ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion to remove we from the sentence. If accepted, should be applied everywhere.

Also, will customers know what this means?

Suggested change
The native signature does not exist. We provide this additional overload for completeness.
The native signature doesn't exist. This additional overload is provided for completeness.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I applied the change. @tannergooding @CarolEidt, if a customer that is familiar with these APIs going to understand remarks like this?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I believe they will. The point is that, while most of these map to "native" C++ intrinsics, some do not. For example, these take an address (pointer), since the instruction supports an in-memory operand. The C++ intrinsics don't provide those as distinct overloads.


]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3642,7 +3652,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
<para>__m256i _mm256_cvtepu8_epi16 (__m128i a)</para>
<para>VPMOVZXBW ymm, xmm</para>
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -3698,7 +3711,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXBW ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3722,7 +3745,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXBD ymm, m64</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3746,7 +3779,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXWD ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3771,7 +3814,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
__m256i _mm256_cvtepu8_epi32 (__m128i a)
VPMOVZXBD ymm, xmm
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -3860,7 +3906,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
__m256i _mm256_cvtepu16_epi32 (__m128i a)
VPMOVZXWD ymm, xmm
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3884,7 +3933,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXBD ymm, m64</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3908,7 +3967,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXWD ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3932,7 +4001,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXBQ ymm, m32</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3956,7 +4035,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXWQ ymm, m64</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -3980,7 +4069,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXDQ ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -4005,7 +4104,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
__m256i _mm256_cvtepu8_epi64 (__m128i a)
VPMOVZXBQ ymm, xmm
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -4126,7 +4228,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
__m256i _mm256_cvtepu16_epi64 (__m128i a)
VPMOVZXWQ ymm, xmm
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -4151,7 +4256,10 @@
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>
__m256i _mm256_cvtepu32_epi64 (__m128i a)
VPMOVZXDQ ymm, xmm
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -4175,7 +4283,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVSXBQ ymm, m32</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -4199,7 +4317,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXWQ ymm, m64</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -4223,7 +4351,17 @@
</Parameters>
<Docs>
<param name="address">To be added.</param>
<summary>To be added.</summary>
<summary>VPMOVZXDQ ymm, m128</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The native signature does not exist. We provide this additional overload for completeness.

]]></format>
</remarks>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading