Skip to content

Commit ef6a96c

Browse files
carlossanlopRon Petrusha
authored andcommitted
coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.C* (#2715)
* coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.C* * suggestion by anipik * Update ConditionalWeakTable`2.xml * Update ConfiguredCancelableAsyncEnumerable`1+Enumerator.xml * Update ConfiguredCancelableAsyncEnumerable`1.xml * Update ConfiguredValueTaskAwaitable+ConfiguredValueTaskAwaiter.xml * Update ConfiguredValueTaskAwaitable.xml * Update ConfiguredValueTaskAwaitable`1+ConfiguredValueTaskAwaiter.xml * Update ConfiguredValueTaskAwaitable`1.xml
1 parent 414b3d3 commit ef6a96c

8 files changed

+61
-52
lines changed

xml/System.Runtime.CompilerServices/ConditionalWeakTable`2.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,10 +232,11 @@
232232
<Parameter Name="value" Type="TValue" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
233233
</Parameters>
234234
<Docs>
235-
<param name="key">To be added.</param>
236-
<param name="value">To be added.</param>
237-
<summary>To be added.</summary>
235+
<param name="key">The key to add or update. May not be <see langword="null" />.</param>
236+
<param name="value">The value to associate with <paramref name="key" />.</param>
237+
<summary>Adds the key and value if the key doesn't exist, or updates the existing key's value if it does exist.</summary>
238238
<remarks>To be added.</remarks>
239+
<exception cref="T:System.ArgumentNullException"><paramref name="key" /> is <see langword="null" />.</exception>
239240
</Docs>
240241
</Member>
241242
<Member MemberName="Clear">
@@ -266,7 +267,7 @@
266267
</ReturnValue>
267268
<Parameters />
268269
<Docs>
269-
<summary>To be added.</summary>
270+
<summary>Clears all the key/value pairs.</summary>
270271
<remarks>To be added.</remarks>
271272
</Docs>
272273
</Member>
@@ -660,4 +661,4 @@
660661
</Docs>
661662
</Member>
662663
</Members>
663-
</Type>
664+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredAsyncDisposable.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</Attribute>
2424
</Attributes>
2525
<Docs>
26-
<summary>To be added.</summary>
26+
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable" /> are performed.</summary>
2727
<remarks>To be added.</remarks>
2828
</Docs>
2929
<Members>

xml/System.Runtime.CompilerServices/ConfiguredCancelableAsyncEnumerable`1+Enumerator.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29-
<summary>To be added.</summary>
29+
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
3030
<remarks>To be added.</remarks>
3131
</Docs>
3232
<Members>
@@ -50,8 +50,8 @@
5050
<ReturnType>T</ReturnType>
5151
</ReturnValue>
5252
<Docs>
53-
<summary>To be added.</summary>
54-
<value>To be added.</value>
53+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
54+
<value>The element in the collection at the current position of the enumerator.</value>
5555
<remarks>To be added.</remarks>
5656
</Docs>
5757
</Member>
@@ -76,8 +76,8 @@
7676
</ReturnValue>
7777
<Parameters />
7878
<Docs>
79-
<summary>To be added.</summary>
80-
<returns>To be added.</returns>
79+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
80+
<returns>A task that represents the asynchronous dispose operation.</returns>
8181
<remarks>To be added.</remarks>
8282
</Docs>
8383
</Member>
@@ -102,10 +102,10 @@
102102
</ReturnValue>
103103
<Parameters />
104104
<Docs>
105-
<summary>To be added.</summary>
106-
<returns>To be added.</returns>
105+
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
106+
<returns>A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" /> that will complete with a result of <see langword="true" /> if the enumerator was successfully advanced to the next element, or <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
107107
<remarks>To be added.</remarks>
108108
</Docs>
109109
</Member>
110110
</Members>
111-
</Type>
111+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredCancelableAsyncEnumerable`1.xml

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
</Attributes>
2828
<Docs>
2929
<typeparam name="T">To be added.</typeparam>
30-
<summary>To be added.</summary>
30+
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
3131
<remarks>To be added.</remarks>
3232
</Docs>
3333
<Members>
@@ -54,10 +54,14 @@
5454
<Parameter Name="continueOnCapturedContext" Type="System.Boolean" />
5555
</Parameters>
5656
<Docs>
57-
<param name="continueOnCapturedContext">To be added.</param>
58-
<summary>To be added.</summary>
59-
<returns>To be added.</returns>
60-
<remarks>To be added.</remarks>
57+
<param name="continueOnCapturedContext"><see langword="true" /> to capture and marshal back to the current context; otherwise, <see langword="false" />.</param>
58+
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
59+
<returns>The configured enumerable.</returns>
60+
<remarks>
61+
<format type="text/markdown"><![CDATA[
62+
This will replace any previous value set by <xref:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)> for this iteration.
63+
]]></format>
64+
</remarks>
6165
</Docs>
6266
</Member>
6367
<Member MemberName="GetAsyncEnumerator">
@@ -108,11 +112,15 @@
108112
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
109113
</Parameters>
110114
<Docs>
111-
<param name="cancellationToken">To be added.</param>
112-
<summary>To be added.</summary>
113-
<returns>To be added.</returns>
114-
<remarks>To be added.</remarks>
115+
<param name="cancellationToken">The cancellation token to use.</param>
116+
<summary>Sets the <see cref="T:System.Threading.CancellationToken" /> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" /> when iterating.</summary>
117+
<returns>The configured enumerable.</returns>
118+
<remarks>
119+
<format type="text/markdown"><![CDATA[
120+
This will replace any previous <xref:System.Threading.CancellationToken> set by <xref:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)> for this iteration.
121+
]]></format>
122+
</remarks>
115123
</Docs>
116124
</Member>
117125
</Members>
118-
</Type>
126+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredValueTaskAwaitable+ConfiguredValueTaskAwaiter.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<summary>To be added.</summary>
33+
<summary>Provides an awaiter for a <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" />.</summary>
3434
<remarks>To be added.</remarks>
3535
</Docs>
3636
<Members>
@@ -55,7 +55,7 @@
5555
</ReturnValue>
5656
<Parameters />
5757
<Docs>
58-
<summary>To be added.</summary>
58+
<summary>Gets the result of the ValueTask.</summary>
5959
<remarks>To be added.</remarks>
6060
</Docs>
6161
</Member>
@@ -79,8 +79,8 @@
7979
<ReturnType>System.Boolean</ReturnType>
8080
</ReturnValue>
8181
<Docs>
82-
<summary>To be added.</summary>
83-
<value>To be added.</value>
82+
<summary>Gets a value that indicates whether the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" /> has completed.</summary>
83+
<value><see langword="true" /> if the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" /> has completed; otherwise, <see langword="false" />.</value>
8484
<remarks>To be added.</remarks>
8585
</Docs>
8686
</Member>
@@ -110,8 +110,8 @@
110110
<Parameter Name="continuation" Type="System.Action" />
111111
</Parameters>
112112
<Docs>
113-
<param name="continuation">To be added.</param>
114-
<summary>To be added.</summary>
113+
<param name="continuation">The continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" />.</param>
114+
<summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" />.</summary>
115115
<remarks>To be added.</remarks>
116116
</Docs>
117117
</Member>
@@ -141,10 +141,10 @@
141141
<Parameter Name="continuation" Type="System.Action" />
142142
</Parameters>
143143
<Docs>
144-
<param name="continuation">To be added.</param>
145-
<summary>To be added.</summary>
144+
<param name="continuation">The continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" />.</param>
145+
<summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" />.</summary>
146146
<remarks>To be added.</remarks>
147147
</Docs>
148148
</Member>
149149
</Members>
150-
</Type>
150+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredValueTaskAwaitable.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29-
<summary>To be added.</summary>
29+
<summary>Provides an awaitable type that enables configured awaits on a <see cref="T:System.Threading.Tasks.ValueTask" />.</summary>
3030
<remarks>To be added.</remarks>
3131
</Docs>
3232
<Members>
@@ -54,10 +54,10 @@
5454
</ReturnValue>
5555
<Parameters />
5656
<Docs>
57-
<summary>To be added.</summary>
58-
<returns>To be added.</returns>
57+
<summary>Returns an awaiter for this <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable" /> instance.</summary>
58+
<returns>The awaiter for this instance.</returns>
5959
<remarks>To be added.</remarks>
6060
</Docs>
6161
</Member>
6262
</Members>
63-
</Type>
63+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredValueTaskAwaitable`1+ConfiguredValueTaskAwaiter.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
</Attribute>
4040
</Attributes>
4141
<Docs>
42-
<summary>To be added.</summary>
42+
<summary>Provides an awaiter for a <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" />.</summary>
4343
<remarks>To be added.</remarks>
4444
</Docs>
4545
<Members>
@@ -70,8 +70,8 @@
7070
</ReturnValue>
7171
<Parameters />
7272
<Docs>
73-
<summary>To be added.</summary>
74-
<returns>To be added.</returns>
73+
<summary>Gets the result of the <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
74+
<returns>The result of the <see cref="T:System.Threading.Tasks.ValueTask`1" />.</returns>
7575
<remarks>To be added.</remarks>
7676
</Docs>
7777
</Member>
@@ -101,8 +101,8 @@
101101
<ReturnType>System.Boolean</ReturnType>
102102
</ReturnValue>
103103
<Docs>
104-
<summary>To be added.</summary>
105-
<value>To be added.</value>
104+
<summary>Gets a value that indicates whether the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" /> has completed.</summary>
105+
<value><see langword="true" /> if the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" /> has completed; otherwise, <see langword="false" />.</value>
106106
<remarks>To be added.</remarks>
107107
</Docs>
108108
</Member>
@@ -138,8 +138,8 @@
138138
<Parameter Name="continuation" Type="System.Action" />
139139
</Parameters>
140140
<Docs>
141-
<param name="continuation">To be added.</param>
142-
<summary>To be added.</summary>
141+
<param name="continuation">The continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" />.</param>
142+
<summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" />.</summary>
143143
<remarks>To be added.</remarks>
144144
</Docs>
145145
</Member>
@@ -175,10 +175,10 @@
175175
<Parameter Name="continuation" Type="System.Action" />
176176
</Parameters>
177177
<Docs>
178-
<param name="continuation">To be added.</param>
179-
<summary>To be added.</summary>
178+
<param name="continuation">The continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" />.</param>
179+
<summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" />.</summary>
180180
<remarks>To be added.</remarks>
181181
</Docs>
182182
</Member>
183183
</Members>
184-
</Type>
184+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredValueTaskAwaitable`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
</Attribute>
3333
</Attributes>
3434
<Docs>
35-
<typeparam name="TResult">To be added.</typeparam>
36-
<summary>To be added.</summary>
35+
<typeparam name="TResult">The type of the produced result.</typeparam>
36+
<summary>Provides an awaitable type that enables configured awaits on a <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
3737
<remarks>To be added.</remarks>
3838
</Docs>
3939
<Members>
@@ -64,10 +64,10 @@
6464
</ReturnValue>
6565
<Parameters />
6666
<Docs>
67-
<summary>To be added.</summary>
68-
<returns>To be added.</returns>
67+
<summary>Returns an awaiter for this <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" /> instance.</summary>
68+
<returns>The awaiter for this instance.</returns>
6969
<remarks>To be added.</remarks>
7070
</Docs>
7171
</Member>
7272
</Members>
73-
</Type>
73+
</Type>

0 commit comments

Comments
 (0)