Intrinsics: Enclose instructions with param, move comments to remarks. (

#3125)
dotnet · Sep 6, 2019 · 3e35e97 · 3e35e97
1 parent e4ae8e2
commit 3e35e97
Show file tree

Hide file tree

Showing 19 changed files with 718 additions and 1,487 deletions.
diff --git a/xml/System.Runtime.Intrinsics.X86/Aes.xml b/xml/System.Runtime.Intrinsics.X86/Aes.xml
@@ -19,9 +19,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>
-            This class provides access to Intel AES hardware instructions via intrinsics
-            </summary>
+    <summary>This class provides access to Intel AES hardware instructions via intrinsics.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -47,10 +45,7 @@
       <Docs>
         <param name="value">To be added.</param>
         <param name="roundKey">To be added.</param>
-        <summary>
-            __m128i _mm_aesdec_si128 (__m128i a, __m128i RoundKey)
-              AESDEC xmm, xmm/m128
-            </summary>
+        <summary><para>__m128i _mm_aesdec_si128 (__m128i a, __m128i RoundKey)</para><para>AESDEC xmm, xmm/m128</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -77,10 +72,7 @@
       <Docs>
         <param name="value">To be added.</param>
         <param name="roundKey">To be added.</param>
-        <summary>
-            __m128i _mm_aesdeclast_si128 (__m128i a, __m128i RoundKey)
-              AESDECLAST xmm, xmm/m128
-            </summary>
+        <summary><para>__m128i _mm_aesdeclast_si128 (__m128i a, __m128i RoundKey)</para><para>AESDECLAST xmm, xmm/m128</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -107,10 +99,7 @@
       <Docs>
         <param name="value">To be added.</param>
         <param name="roundKey">To be added.</param>
-        <summary>
-            __m128i _mm_aesenc_si128 (__m128i a, __m128i RoundKey)
-              AESENC xmm, xmm/m128
-            </summary>
+        <summary><para>__m128i _mm_aesenc_si128 (__m128i a, __m128i RoundKey)</para><para>AESENC xmm, xmm/m128</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -137,10 +126,7 @@
       <Docs>
         <param name="value">To be added.</param>
         <param name="roundKey">To be added.</param>
-        <summary>
-            __m128i _mm_aesenclast_si128 (__m128i a, __m128i RoundKey)
-              AESENCLAST xmm, xmm/m128
-            </summary>
+        <summary><para>__m128i _mm_aesenclast_si128 (__m128i a, __m128i RoundKey)</para><para>AESENCLAST xmm, xmm/m128</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -165,10 +151,7 @@
       </Parameters>
       <Docs>
         <param name="value">To be added.</param>
-        <summary>
-            __m128i _mm_aesimc_si128 (__m128i a)
-              AESIMC xmm, xmm/m128
-            </summary>
+        <summary><para>__m128i _mm_aesimc_si128 (__m128i a)</para><para>AESIMC xmm, xmm/m128</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -216,10 +199,7 @@
       <Docs>
         <param name="value">To be added.</param>
         <param name="control">To be added.</param>
-        <summary>
-            __m128i _mm_aeskeygenassist_si128 (__m128i a, const int imm8)
-              AESKEYGENASSIST xmm, xmm/m128, imm8
-            </summary>
+        <summary><para>__m128i _mm_aeskeygenassist_si128 (__m128i a, const int imm8)</para><para>AESKEYGENASSIST xmm, xmm/m128, imm8</para></summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>