Skip to content

Commit accad7b

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.A* (#2714)
* coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.A* * Update AsyncMethodBuilderAttribute.xml * Update AsyncValueTaskMethodBuilder.xml * Update AsyncValueTaskMethodBuilder`1.xml
1 parent ffc7a87 commit accad7b

File tree

5 files changed

+75
-75
lines changed

5 files changed

+75
-75
lines changed

‎xml/System.Runtime.CompilerServices/AsyncIteratorMethodBuilder.xml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<summary>Represents a builder for asynchronous iterators.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -58,11 +58,11 @@
5858
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
5959
</Parameters>
6060
<Docs>
61-
<typeparam name="TAwaiter">To be added.</typeparam>
62-
<typeparam name="TStateMachine">To be added.</typeparam>
63-
<param name="awaiter">To be added.</param>
64-
<param name="stateMachine">To be added.</param>
65-
<summary>To be added.</summary>
61+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
62+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
63+
<param name="awaiter">The awaiter.</param>
64+
<param name="stateMachine">The state machine.</param>
65+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>
@@ -102,11 +102,11 @@
102102
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
103103
</Parameters>
104104
<Docs>
105-
<typeparam name="TAwaiter">To be added.</typeparam>
106-
<typeparam name="TStateMachine">To be added.</typeparam>
107-
<param name="awaiter">To be added.</param>
108-
<param name="stateMachine">To be added.</param>
109-
<summary>To be added.</summary>
105+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
106+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
107+
<param name="awaiter">The awaiter.</param>
108+
<param name="stateMachine">The state machine.</param>
109+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
110110
<remarks>To be added.</remarks>
111111
</Docs>
112112
</Member>
@@ -131,7 +131,7 @@
131131
</ReturnValue>
132132
<Parameters />
133133
<Docs>
134-
<summary>To be added.</summary>
134+
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
135135
<remarks>To be added.</remarks>
136136
</Docs>
137137
</Member>
@@ -156,8 +156,8 @@
156156
</ReturnValue>
157157
<Parameters />
158158
<Docs>
159-
<summary>To be added.</summary>
160-
<returns>To be added.</returns>
159+
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder" /> struct.</summary>
160+
<returns>The initialized instance.</returns>
161161
<remarks>To be added.</remarks>
162162
</Docs>
163163
</Member>
@@ -191,9 +191,9 @@
191191
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
192192
</Parameters>
193193
<Docs>
194-
<typeparam name="TStateMachine">To be added.</typeparam>
195-
<param name="stateMachine">To be added.</param>
196-
<summary>To be added.</summary>
194+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
195+
<param name="stateMachine">The state machine instance, passed by reference.</param>
196+
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext" /> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext" />.</summary>
197197
<remarks>To be added.</remarks>
198198
</Docs>
199199
</Member>

‎xml/System.Runtime.CompilerServices/AsyncIteratorStateMachineAttribute.xml

Lines changed: 3 additions & 3 deletions
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>Indicates whether a method is an asynchronous iterator.</summary>
2727
<remarks>To be added.</remarks>
2828
</Docs>
2929
<Members>
@@ -47,8 +47,8 @@
4747
<Parameter Name="stateMachineType" Type="System.Type" />
4848
</Parameters>
4949
<Docs>
50-
<param name="stateMachineType">To be added.</param>
51-
<summary>To be added.</summary>
50+
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
51+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute" /> class.</summary>
5252
<remarks>To be added.</remarks>
5353
</Docs>
5454
</Member>

‎xml/System.Runtime.CompilerServices/AsyncMethodBuilderAttribute.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</Attribute>
3232
</Attributes>
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Indicates the type of the async method builder that should be used by a language compiler to build the attributed type when used as the return type of an async method.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members>
@@ -60,8 +60,8 @@
6060
<Parameter Name="builderType" Type="System.Type" />
6161
</Parameters>
6262
<Docs>
63-
<param name="builderType">To be added.</param>
64-
<summary>To be added.</summary>
63+
<param name="builderType">The type of the associated builder.</param>
64+
<summary>Initializes a new instance of the the <see cref="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute" /> class.</summary>
6565
<remarks>To be added.</remarks>
6666
</Docs>
6767
</Member>
@@ -90,10 +90,10 @@
9090
<ReturnType>System.Type</ReturnType>
9191
</ReturnValue>
9292
<Docs>
93-
<summary>To be added.</summary>
94-
<value>To be added.</value>
93+
<summary>Gets the type of the associated builder.</summary>
94+
<value>The type of the associated builder.</value>
9595
<remarks>To be added.</remarks>
9696
</Docs>
9797
</Member>
9898
</Members>
99-
</Type>
99+
</Type>

‎xml/System.Runtime.CompilerServices/AsyncValueTaskMethodBuilder.xml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</Base>
2222
<Interfaces />
2323
<Docs>
24-
<summary>To be added.</summary>
24+
<summary>Represents a builder for asynchronous methods that return a <see cref="T:System.Threading.Tasks.ValueTask" />.</summary>
2525
<remarks>To be added.</remarks>
2626
</Docs>
2727
<Members>
@@ -64,11 +64,11 @@
6464
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
6565
</Parameters>
6666
<Docs>
67-
<typeparam name="TAwaiter">To be added.</typeparam>
68-
<typeparam name="TStateMachine">To be added.</typeparam>
69-
<param name="awaiter">To be added.</param>
70-
<param name="stateMachine">To be added.</param>
71-
<summary>To be added.</summary>
67+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
68+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
69+
<param name="awaiter">The awaiter.</param>
70+
<param name="stateMachine">The state machine.</param>
71+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
7272
<remarks>To be added.</remarks>
7373
</Docs>
7474
</Member>
@@ -111,11 +111,11 @@
111111
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
112112
</Parameters>
113113
<Docs>
114-
<typeparam name="TAwaiter">To be added.</typeparam>
115-
<typeparam name="TStateMachine">To be added.</typeparam>
116-
<param name="awaiter">To be added.</param>
117-
<param name="stateMachine">To be added.</param>
118-
<summary>To be added.</summary>
114+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
115+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
116+
<param name="awaiter">The awaiter.</param>
117+
<param name="stateMachine">The state machine.</param>
118+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
119119
<remarks>To be added.</remarks>
120120
</Docs>
121121
</Member>
@@ -143,8 +143,8 @@
143143
</ReturnValue>
144144
<Parameters />
145145
<Docs>
146-
<summary>To be added.</summary>
147-
<returns>To be added.</returns>
146+
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder" /> struct.</summary>
147+
<returns>The initialized instance.</returns>
148148
<remarks>To be added.</remarks>
149149
</Docs>
150150
</Member>
@@ -173,8 +173,8 @@
173173
<Parameter Name="exception" Type="System.Exception" />
174174
</Parameters>
175175
<Docs>
176-
<param name="exception">To be added.</param>
177-
<summary>To be added.</summary>
176+
<param name="exception">The exception to bind to the task.</param>
177+
<summary>Marks the task as failed and binds the specified exception to the task.</summary>
178178
<remarks>To be added.</remarks>
179179
</Docs>
180180
</Member>
@@ -202,7 +202,7 @@
202202
</ReturnValue>
203203
<Parameters />
204204
<Docs>
205-
<summary>To be added.</summary>
205+
<summary>Marks the task as successfully completed.</summary>
206206
<remarks>To be added.</remarks>
207207
</Docs>
208208
</Member>
@@ -232,8 +232,8 @@
232232
<Parameter Name="stateMachine" Type="System.Runtime.CompilerServices.IAsyncStateMachine" />
233233
</Parameters>
234234
<Docs>
235-
<param name="stateMachine">To be added.</param>
236-
<summary>To be added.</summary>
235+
<param name="stateMachine">The state machine instance to associate with the builder.</param>
236+
<summary>Associates the builder with the specified state machine.</summary>
237237
<remarks>To be added.</remarks>
238238
</Docs>
239239
</Member>
@@ -270,9 +270,9 @@
270270
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
271271
</Parameters>
272272
<Docs>
273-
<typeparam name="TStateMachine">To be added.</typeparam>
274-
<param name="stateMachine">To be added.</param>
275-
<summary>To be added.</summary>
273+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
274+
<param name="stateMachine">The state machine instance, passed by reference.</param>
275+
<summary>Begins running the builder with the associated state machine.</summary>
276276
<remarks>To be added.</remarks>
277277
</Docs>
278278
</Member>
@@ -299,10 +299,10 @@
299299
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
300300
</ReturnValue>
301301
<Docs>
302-
<summary>To be added.</summary>
303-
<value>To be added.</value>
302+
<summary>Gets the task for this builder.</summary>
303+
<value>The task for this builder.</value>
304304
<remarks>To be added.</remarks>
305305
</Docs>
306306
</Member>
307307
</Members>
308-
</Type>
308+
</Type>

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<Interfaces />
2828
<Docs>
2929
<typeparam name="TResult">To be added.</typeparam>
30-
<summary>To be added.</summary>
30+
<summary>Represents a builder for asynchronous methods that returns a <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
3131
<remarks>To be added.</remarks>
3232
</Docs>
3333
<Members>
@@ -72,11 +72,11 @@
7272
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
7373
</Parameters>
7474
<Docs>
75-
<typeparam name="TAwaiter">To be added.</typeparam>
76-
<typeparam name="TStateMachine">To be added.</typeparam>
77-
<param name="awaiter">To be added.</param>
78-
<param name="stateMachine">To be added.</param>
79-
<summary>To be added.</summary>
75+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
76+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
77+
<param name="awaiter">The awaiter.</param>
78+
<param name="stateMachine">The state machine.</param>
79+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
8080
<remarks>To be added.</remarks>
8181
</Docs>
8282
</Member>
@@ -126,11 +126,11 @@
126126
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
127127
</Parameters>
128128
<Docs>
129-
<typeparam name="TAwaiter">To be added.</typeparam>
130-
<typeparam name="TStateMachine">To be added.</typeparam>
131-
<param name="awaiter">To be added.</param>
132-
<param name="stateMachine">To be added.</param>
133-
<summary>To be added.</summary>
129+
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
130+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
131+
<param name="awaiter">The awaiter.</param>
132+
<param name="stateMachine">The state machine.</param>
133+
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
134134
<remarks>To be added.</remarks>
135135
</Docs>
136136
</Member>
@@ -160,8 +160,8 @@
160160
</ReturnValue>
161161
<Parameters />
162162
<Docs>
163-
<summary>To be added.</summary>
164-
<returns>To be added.</returns>
163+
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1" /> struct.</summary>
164+
<returns>The initialized instance.</returns>
165165
<remarks>To be added.</remarks>
166166
</Docs>
167167
</Member>
@@ -192,8 +192,8 @@
192192
<Parameter Name="exception" Type="System.Exception" />
193193
</Parameters>
194194
<Docs>
195-
<param name="exception">To be added.</param>
196-
<summary>To be added.</summary>
195+
<param name="exception">The exception to bind to the task.</param>
196+
<summary>Marks the task as failed and binds the specified exception to the task.</summary>
197197
<remarks>To be added.</remarks>
198198
</Docs>
199199
</Member>
@@ -225,8 +225,8 @@
225225
<Parameter Name="result" Type="TResult" />
226226
</Parameters>
227227
<Docs>
228-
<param name="result">To be added.</param>
229-
<summary>To be added.</summary>
228+
<param name="result">The result to use to complete the task.</param>
229+
<summary>Marks the task as successfully completed.</summary>
230230
<remarks>To be added.</remarks>
231231
</Docs>
232232
</Member>
@@ -258,8 +258,8 @@
258258
<Parameter Name="stateMachine" Type="System.Runtime.CompilerServices.IAsyncStateMachine" />
259259
</Parameters>
260260
<Docs>
261-
<param name="stateMachine">To be added.</param>
262-
<summary>To be added.</summary>
261+
<param name="stateMachine">The state machine instance to associate with the builder.</param>
262+
<summary>Associates the builder with the specified state machine.</summary>
263263
<remarks>To be added.</remarks>
264264
</Docs>
265265
</Member>
@@ -298,9 +298,9 @@
298298
<Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
299299
</Parameters>
300300
<Docs>
301-
<typeparam name="TStateMachine">To be added.</typeparam>
302-
<param name="stateMachine">To be added.</param>
303-
<summary>To be added.</summary>
301+
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
302+
<param name="stateMachine">The state machine instance, passed by reference.</param>
303+
<summary>Begins running the builder with the associated state machine.</summary>
304304
<remarks>To be added.</remarks>
305305
</Docs>
306306
</Member>
@@ -329,10 +329,10 @@
329329
<ReturnType>System.Threading.Tasks.ValueTask&lt;TResult&gt;</ReturnType>
330330
</ReturnValue>
331331
<Docs>
332-
<summary>To be added.</summary>
333-
<value>To be added.</value>
332+
<summary>Gets the task for this builder.</summary>
333+
<value>The task for this builder.</value>
334334
<remarks>To be added.</remarks>
335335
</Docs>
336336
</Member>
337337
</Members>
338-
</Type>
338+
</Type>

0 commit comments

Comments
 (0)