Skip to content

Commit 5361fe1

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Port new triple slash docs for .NET 7 Alpha [Dec '21 - Jan '22] (#7603)
* Microsoft.Extensions.Hosting * System.Reflection.Metadata * System.Runtime.Intrinsics.X86 * System.Threading * suggestions by gewarren Co-authored-by: Genevieve Warren <[email protected]> * Revert "System.Threading" This reverts commit b8b7c5b. Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent e9f78e3 commit 5361fe1

File tree

4 files changed

+59
-30
lines changed

4 files changed

+59
-30
lines changed

‎xml/Microsoft.Extensions.Hosting/BackgroundService.xml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,15 @@
109109
<summary>This method is called when the <see cref="T:Microsoft.Extensions.Hosting.IHostedService" /> starts. The implementation should return a task that represents
110110
the lifetime of the long running operation(s) being performed.</summary>
111111
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the long running operations.</returns>
112-
<remarks>To be added.</remarks>
112+
<remarks>
113+
<format type="text/markdown"><![CDATA[
114+
115+
## Remarks
116+
117+
For implementation guidelines, see [Worker Services in .NET](/dotnet/core/extensions/workers).
118+
119+
]]></format>
120+
</remarks>
113121
</Docs>
114122
</Member>
115123
<Member MemberName="ExecuteTask">

‎xml/Microsoft.Extensions.Hosting/HostBuilder.xml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,17 @@
7474
</ReturnValue>
7575
<Parameters />
7676
<Docs>
77-
<summary>Run the given actions to initialize the host. This can only be called once.</summary>
77+
<summary>Runs the given actions to initialize the host. This method can only be called once.</summary>
7878
<returns>An initialized <see cref="T:Microsoft.Extensions.Hosting.IHost" />.</returns>
79-
<remarks>To be added.</remarks>
79+
<remarks>
80+
<format type="text/markdown"><![CDATA[
81+
82+
## Remarks
83+
84+
This method adds basic services to the host, such as application lifetime, host environment, and logging.
85+
86+
]]></format>
87+
</remarks>
8088
</Docs>
8189
</Member>
8290
<Member MemberName="ConfigureAppConfiguration">

‎xml/System.Reflection.Metadata/AssemblyExtensions.xml‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,25 @@
6464
<Parameter Name="length" Type="System.Int32" RefType="out" />
6565
</Parameters>
6666
<Docs>
67-
<param name="assembly">To be added.</param>
68-
<param name="blob">To be added.</param>
69-
<param name="length">To be added.</param>
70-
<summary>To be added.</summary>
71-
<returns>To be added.</returns>
72-
<remarks>To be added.</remarks>
67+
<param name="assembly">The assembly from which to retrieve the metadata.</param>
68+
<param name="blob">When this method returns, contains the pointer to the metadata section blob.</param>
69+
<param name="length">When this method returns, contains the length of the metadata section blob.</param>
70+
<summary>Retrieves the metadata section of the assembly, for use with <see cref="T:System.Reflection.Metadata.MetadataReader" />.</summary>
71+
<returns>
72+
<see langword="true" /> if the metadata is retrieved successfully; <see langword="false" /> upon failure. The metadata might not be available for some assemblies, such as <see cref="T:System.Reflection.Emit.AssemblyBuilder" /> and AOT images.</returns>
73+
<remarks>
74+
<format type="text/markdown"><![CDATA[
75+
76+
## Remarks
77+
78+
Callers should not write to the metadata blob.
79+
80+
The metadata blob pointer will remain valid as long as the assembly is alive.
81+
82+
The caller is responsible for keeping the assembly object alive while accessing the metadata blob.
83+
84+
]]></format>
85+
</remarks>
7386
</Docs>
7487
</Member>
7588
</Members>

‎xml/System.Runtime.Intrinsics.X86/Sse41.xml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3995,7 +3995,7 @@ The native signature doesn't exist. This additional overload is provided for com
39953995
<Docs>
39963996
<param name="left">To be added.</param>
39973997
<param name="right">To be added.</param>
3998-
<summary>To be added.</summary>
3998+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
39993999
<returns>To be added.</returns>
40004000
<remarks>To be added.</remarks>
40014001
</Docs>
@@ -4025,7 +4025,7 @@ The native signature doesn't exist. This additional overload is provided for com
40254025
<Docs>
40264026
<param name="left">To be added.</param>
40274027
<param name="right">To be added.</param>
4028-
<summary>To be added.</summary>
4028+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
40294029
<returns>To be added.</returns>
40304030
<remarks>To be added.</remarks>
40314031
</Docs>
@@ -4055,7 +4055,7 @@ The native signature doesn't exist. This additional overload is provided for com
40554055
<Docs>
40564056
<param name="left">To be added.</param>
40574057
<param name="right">To be added.</param>
4058-
<summary>To be added.</summary>
4058+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
40594059
<returns>To be added.</returns>
40604060
<remarks>To be added.</remarks>
40614061
</Docs>
@@ -4085,7 +4085,7 @@ The native signature doesn't exist. This additional overload is provided for com
40854085
<Docs>
40864086
<param name="left">To be added.</param>
40874087
<param name="right">To be added.</param>
4088-
<summary>To be added.</summary>
4088+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
40894089
<returns>To be added.</returns>
40904090
<remarks>To be added.</remarks>
40914091
</Docs>
@@ -4148,7 +4148,7 @@ The native signature doesn't exist. This additional overload is provided for com
41484148
<Docs>
41494149
<param name="left">To be added.</param>
41504150
<param name="right">To be added.</param>
4151-
<summary>To be added.</summary>
4151+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
41524152
<returns>To be added.</returns>
41534153
<remarks>To be added.</remarks>
41544154
</Docs>
@@ -4178,7 +4178,7 @@ The native signature doesn't exist. This additional overload is provided for com
41784178
<Docs>
41794179
<param name="left">To be added.</param>
41804180
<param name="right">To be added.</param>
4181-
<summary>To be added.</summary>
4181+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
41824182
<returns>To be added.</returns>
41834183
<remarks>To be added.</remarks>
41844184
</Docs>
@@ -4208,7 +4208,7 @@ The native signature doesn't exist. This additional overload is provided for com
42084208
<Docs>
42094209
<param name="left">To be added.</param>
42104210
<param name="right">To be added.</param>
4211-
<summary>To be added.</summary>
4211+
<summary>int _mm_testc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
42124212
<returns>To be added.</returns>
42134213
<remarks>To be added.</remarks>
42144214
</Docs>
@@ -4238,7 +4238,7 @@ The native signature doesn't exist. This additional overload is provided for com
42384238
<Docs>
42394239
<param name="left">To be added.</param>
42404240
<param name="right">To be added.</param>
4241-
<summary>To be added.</summary>
4241+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
42424242
<returns>To be added.</returns>
42434243
<remarks>To be added.</remarks>
42444244
</Docs>
@@ -4268,7 +4268,7 @@ The native signature doesn't exist. This additional overload is provided for com
42684268
<Docs>
42694269
<param name="left">To be added.</param>
42704270
<param name="right">To be added.</param>
4271-
<summary>To be added.</summary>
4271+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
42724272
<returns>To be added.</returns>
42734273
<remarks>To be added.</remarks>
42744274
</Docs>
@@ -4298,7 +4298,7 @@ The native signature doesn't exist. This additional overload is provided for com
42984298
<Docs>
42994299
<param name="left">To be added.</param>
43004300
<param name="right">To be added.</param>
4301-
<summary>To be added.</summary>
4301+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
43024302
<returns>To be added.</returns>
43034303
<remarks>To be added.</remarks>
43044304
</Docs>
@@ -4328,7 +4328,7 @@ The native signature doesn't exist. This additional overload is provided for com
43284328
<Docs>
43294329
<param name="left">To be added.</param>
43304330
<param name="right">To be added.</param>
4331-
<summary>To be added.</summary>
4331+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
43324332
<returns>To be added.</returns>
43334333
<remarks>To be added.</remarks>
43344334
</Docs>
@@ -4391,7 +4391,7 @@ The native signature doesn't exist. This additional overload is provided for com
43914391
<Docs>
43924392
<param name="left">To be added.</param>
43934393
<param name="right">To be added.</param>
4394-
<summary>To be added.</summary>
4394+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
43954395
<returns>To be added.</returns>
43964396
<remarks>To be added.</remarks>
43974397
</Docs>
@@ -4421,7 +4421,7 @@ The native signature doesn't exist. This additional overload is provided for com
44214421
<Docs>
44224422
<param name="left">To be added.</param>
44234423
<param name="right">To be added.</param>
4424-
<summary>To be added.</summary>
4424+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
44254425
<returns>To be added.</returns>
44264426
<remarks>To be added.</remarks>
44274427
</Docs>
@@ -4451,7 +4451,7 @@ The native signature doesn't exist. This additional overload is provided for com
44514451
<Docs>
44524452
<param name="left">To be added.</param>
44534453
<param name="right">To be added.</param>
4454-
<summary>To be added.</summary>
4454+
<summary>int _mm_testnzc_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
44554455
<returns>To be added.</returns>
44564456
<remarks>To be added.</remarks>
44574457
</Docs>
@@ -4481,7 +4481,7 @@ The native signature doesn't exist. This additional overload is provided for com
44814481
<Docs>
44824482
<param name="left">To be added.</param>
44834483
<param name="right">To be added.</param>
4484-
<summary>To be added.</summary>
4484+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
44854485
<returns>To be added.</returns>
44864486
<remarks>To be added.</remarks>
44874487
</Docs>
@@ -4511,7 +4511,7 @@ The native signature doesn't exist. This additional overload is provided for com
45114511
<Docs>
45124512
<param name="left">To be added.</param>
45134513
<param name="right">To be added.</param>
4514-
<summary>To be added.</summary>
4514+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
45154515
<returns>To be added.</returns>
45164516
<remarks>To be added.</remarks>
45174517
</Docs>
@@ -4541,7 +4541,7 @@ The native signature doesn't exist. This additional overload is provided for com
45414541
<Docs>
45424542
<param name="left">To be added.</param>
45434543
<param name="right">To be added.</param>
4544-
<summary>To be added.</summary>
4544+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
45454545
<returns>To be added.</returns>
45464546
<remarks>To be added.</remarks>
45474547
</Docs>
@@ -4571,7 +4571,7 @@ The native signature doesn't exist. This additional overload is provided for com
45714571
<Docs>
45724572
<param name="left">To be added.</param>
45734573
<param name="right">To be added.</param>
4574-
<summary>To be added.</summary>
4574+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
45754575
<returns>To be added.</returns>
45764576
<remarks>To be added.</remarks>
45774577
</Docs>
@@ -4634,7 +4634,7 @@ The native signature doesn't exist. This additional overload is provided for com
46344634
<Docs>
46354635
<param name="left">To be added.</param>
46364636
<param name="right">To be added.</param>
4637-
<summary>To be added.</summary>
4637+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
46384638
<returns>To be added.</returns>
46394639
<remarks>To be added.</remarks>
46404640
</Docs>
@@ -4664,7 +4664,7 @@ The native signature doesn't exist. This additional overload is provided for com
46644664
<Docs>
46654665
<param name="left">To be added.</param>
46664666
<param name="right">To be added.</param>
4667-
<summary>To be added.</summary>
4667+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
46684668
<returns>To be added.</returns>
46694669
<remarks>To be added.</remarks>
46704670
</Docs>
@@ -4694,7 +4694,7 @@ The native signature doesn't exist. This additional overload is provided for com
46944694
<Docs>
46954695
<param name="left">To be added.</param>
46964696
<param name="right">To be added.</param>
4697-
<summary>To be added.</summary>
4697+
<summary>int _mm_testz_si128 (__m128i a, __m128i b) PTEST xmm, xmm/m128</summary>
46984698
<returns>To be added.</returns>
46994699
<remarks>To be added.</remarks>
47004700
</Docs>

0 commit comments

Comments
 (0)