Skip to content

Commit 94a5e84

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.R*-V* (#2716)
* coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.R*-V* * Update RuntimeFeature.xml * Update RuntimeHelpers.xml * Update ValueTaskAwaiter.xml * Update ValueTaskAwaiter`1.xml * suggestion by anipik
1 parent ee55c4a commit 94a5e84

File tree

6 files changed

+40
-31
lines changed

6 files changed

+40
-31
lines changed

‎xml/System.Runtime.CompilerServices/RuntimeFeature.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<ReturnType>System.String</ReturnType>
5050
</ReturnValue>
5151
<Docs>
52-
<summary>To be added.</summary>
52+
<summary>Indicates that this version of the runtime supports default interface method implementations.</summary>
5353
<remarks>To be added.</remarks>
5454
</Docs>
5555
</Member>
@@ -173,4 +173,4 @@
173173
</Docs>
174174
</Member>
175175
</Members>
176-
</Type>
176+
</Type>

‎xml/System.Runtime.CompilerServices/RuntimeHelpers.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -421,11 +421,11 @@
421421
<Parameter Name="range" Type="System.Range" Index="1" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
422422
</Parameters>
423423
<Docs>
424-
<typeparam name="T">To be added.</typeparam>
425-
<param name="array">To be added.</param>
426-
<param name="range">To be added.</param>
427-
<summary>To be added.</summary>
428-
<returns>To be added.</returns>
424+
<typeparam name="T">The type of the elements in the array.</typeparam>
425+
<param name="array">The array to slice.</param>
426+
<param name="range">An object that determines the portion of <paramref name="array" /> to include in the slice.</param>
427+
<summary>Slices the specified array using the specified range.</summary>
428+
<returns>The subarray defined by <paramref name="range" />.</returns>
429429
<remarks>To be added.</remarks>
430430
</Docs>
431431
</Member>
@@ -543,9 +543,9 @@
543543
</TypeParameters>
544544
<Parameters />
545545
<Docs>
546-
<typeparam name="T">To be added.</typeparam>
547-
<summary>To be added.</summary>
548-
<returns>To be added.</returns>
546+
<typeparam name="T">The type.</typeparam>
547+
<summary>Returns a value that indicates whether the specified type is a reference type or a value type that contains references.</summary>
548+
<returns><see langword="true" /> if the given type is reference type or value type that contains references; otherwise, <see langword="false" />.</returns>
549549
<remarks>To be added.</remarks>
550550
</Docs>
551551
</Member>
@@ -1113,4 +1113,4 @@
11131113
</Docs>
11141114
</Member>
11151115
</Members>
1116-
</Type>
1116+
</Type>

‎xml/System.Runtime.CompilerServices/TaskAwaiter.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@
216216
<paramref name="continuation" /> is <see langword="null" />.</exception>
217217
<exception cref="T:System.NullReferenceException">The <see cref="T:System.Runtime.CompilerServices.TaskAwaiter" /> object was not properly initialized.</exception>
218218
<forInternalUseOnly />
219+
<exception cref="T:System.InvalidOperationException">The awaiter was not properly initialized.</exception>
219220
</Docs>
220221
</Member>
221222
<Member MemberName="UnsafeOnCompleted">
@@ -263,7 +264,11 @@
263264
<Docs>
264265
<param name="continuation">The action to invoke when the await operation completes.</param>
265266
<summary>Schedules the continuation action for the asynchronous task that is associated with this awaiter.</summary>
266-
<remarks>To be added.</remarks>
267+
<remarks>
268+
<format type="text/markdown"><![CDATA[
269+
This method is intended for compiler user rather than use directly in code.
270+
]]></format>
271+
</remarks>
267272
<exception cref="T:System.ArgumentNullException">
268273
<paramref name="continuation" /> is <see langword="null" />.</exception>
269274
<exception cref="T:System.InvalidOperationException">The awaiter was not properly initialized.</exception>

‎xml/System.Runtime.CompilerServices/TaskAwaiter`1.xml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,12 +268,16 @@
268268
<Docs>
269269
<param name="continuation">The action to invoke when the await operation completes.</param>
270270
<summary>Schedules the continuation action for the asynchronous task associated with this awaiter.</summary>
271-
<remarks>To be added.</remarks>
271+
<remarks>
272+
<format type="text/markdown"><![CDATA[
273+
This method is intended for compiler user rather than use directly in code.
274+
]]></format>
275+
</remarks>
272276
<exception cref="T:System.ArgumentNullException">
273277
<paramref name="continuation" /> is <see langword="null" />.</exception>
274-
<exception cref="T:System.InvalidOperationException">The awaiter was not properly initialized.</exception>
275278
<forInternalUseOnly />
279+
<exception cref="T:System.NullReferenceException">The awaiter was not properly initialized.</exception>
276280
</Docs>
277281
</Member>
278282
</Members>
279-
</Type>
283+
</Type>

‎xml/System.Runtime.CompilerServices/ValueTaskAwaiter.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</Attribute>
3434
</Attributes>
3535
<Docs>
36-
<summary>To be added.</summary>
36+
<summary>Provides an awaiter for a <see cref="T:System.Threading.Tasks.ValueTask" />.</summary>
3737
<remarks>To be added.</remarks>
3838
</Docs>
3939
<Members>
@@ -61,7 +61,7 @@
6161
</ReturnValue>
6262
<Parameters />
6363
<Docs>
64-
<summary>To be added.</summary>
64+
<summary>Gets the result of the ValueTask.</summary>
6565
<remarks>To be added.</remarks>
6666
</Docs>
6767
</Member>
@@ -88,8 +88,8 @@
8888
<ReturnType>System.Boolean</ReturnType>
8989
</ReturnValue>
9090
<Docs>
91-
<summary>To be added.</summary>
92-
<value>To be added.</value>
91+
<summary>Gets a value that indicates whether the <see cref="T:System.Threading.Tasks.ValueTask" /> has completed.</summary>
92+
<value><see langword="true" /> if the ValueTask has completed; otherwise, <see langword="false" />.</value>
9393
<remarks>To be added.</remarks>
9494
</Docs>
9595
</Member>
@@ -122,8 +122,8 @@
122122
<Parameter Name="continuation" Type="System.Action" />
123123
</Parameters>
124124
<Docs>
125-
<param name="continuation">To be added.</param>
126-
<summary>To be added.</summary>
125+
<param name="continuation">The continuation action for this <see cref="T:System.Threading.Tasks.ValueTask" />.</param>
126+
<summary>Schedules the continuation action for this <see cref="T:System.Threading.Tasks.ValueTask" />.</summary>
127127
<remarks>To be added.</remarks>
128128
</Docs>
129129
</Member>
@@ -157,9 +157,9 @@
157157
</Parameters>
158158
<Docs>
159159
<param name="continuation">To be added.</param>
160-
<summary>To be added.</summary>
160+
<summary>Schedules the continuation action for this ValueTask.</summary>
161161
<remarks>To be added.</remarks>
162162
</Docs>
163163
</Member>
164164
</Members>
165-
</Type>
165+
</Type>

‎xml/System.Runtime.CompilerServices/ValueTaskAwaiter`1.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
</Attributes>
4141
<Docs>
4242
<typeparam name="TResult">To be added.</typeparam>
43-
<summary>To be added.</summary>
43+
<summary>Provides an awaiter for a <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
4444
<remarks>To be added.</remarks>
4545
</Docs>
4646
<Members>
@@ -71,7 +71,7 @@
7171
</ReturnValue>
7272
<Parameters />
7373
<Docs>
74-
<summary>To be added.</summary>
74+
<summary>Gets the result of the ValueTask.</summary>
7575
<returns>To be added.</returns>
7676
<remarks>To be added.</remarks>
7777
</Docs>
@@ -102,8 +102,8 @@
102102
<ReturnType>System.Boolean</ReturnType>
103103
</ReturnValue>
104104
<Docs>
105-
<summary>To be added.</summary>
106-
<value>To be added.</value>
105+
<summary>Gets a value that indicates whether the <see cref="T:System.Threading.Tasks.ValueTask`1" /> has completed.</summary>
106+
<value><see langword="true" /> if the <see cref="T:System.Threading.Tasks.ValueTask`1" /> has completed; otherwise, <see langword="false" />.</value>
107107
<remarks>To be added.</remarks>
108108
</Docs>
109109
</Member>
@@ -140,7 +140,7 @@
140140
</Parameters>
141141
<Docs>
142142
<param name="continuation">To be added.</param>
143-
<summary>To be added.</summary>
143+
<summary>Schedules the continuation action for this <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
144144
<remarks>To be added.</remarks>
145145
</Docs>
146146
</Member>
@@ -176,10 +176,10 @@
176176
<Parameter Name="continuation" Type="System.Action" />
177177
</Parameters>
178178
<Docs>
179-
<param name="continuation">To be added.</param>
180-
<summary>To be added.</summary>
179+
<param name="continuation">The continuation action for this <see cref="T:System.Threading.Tasks.ValueTask`1" />.</param>
180+
<summary>Schedules the continuation action for this ValueTask.</summary>
181181
<remarks>To be added.</remarks>
182182
</Docs>
183183
</Member>
184184
</Members>
185-
</Type>
185+
</Type>

0 commit comments

Comments
 (0)