coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.A* (#2714)

carlossanlop · Ron Petrusha · commit accad7b50e45 · 2019-07-11T19:04:36.000Z
* coreclr: Automatic port of triple slash from System.Runtime.CompilerServices.A*

* Update AsyncMethodBuilderAttribute.xml

* Update AsyncValueTaskMethodBuilder.xml

* Update AsyncValueTaskMethodBuilder`1.xml
diff --git a/xml/System.Runtime.CompilerServices/AsyncIteratorMethodBuilder.xml b/xml/System.Runtime.CompilerServices/AsyncIteratorMethodBuilder.xml
@@ -18,7 +18,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Represents a builder for asynchronous iterators.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -58,11 +58,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -102,11 +102,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -131,7 +131,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -156,8 +156,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder" /> struct.</summary>
+        <returns>The initialized instance.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -191,9 +191,9 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="stateMachine">The state machine instance, passed by reference.</param>
+        <summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext" /> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/System.Runtime.CompilerServices/AsyncIteratorStateMachineAttribute.xml b/xml/System.Runtime.CompilerServices/AsyncIteratorStateMachineAttribute.xml
@@ -23,7 +23,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Indicates whether a method is an asynchronous iterator.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -47,8 +47,8 @@
         <Parameter Name="stateMachineType" Type="System.Type" />
       </Parameters>
       <Docs>
-        <param name="stateMachineType">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
+        <summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute" /> class.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/System.Runtime.CompilerServices/AsyncMethodBuilderAttribute.xml b/xml/System.Runtime.CompilerServices/AsyncMethodBuilderAttribute.xml
@@ -31,7 +31,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <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>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -60,8 +60,8 @@
         <Parameter Name="builderType" Type="System.Type" />
       </Parameters>
       <Docs>
-        <param name="builderType">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="builderType">The type of the associated builder.</param>
+        <summary>Initializes a new instance of the the <see cref="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute" /> class.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -90,10 +90,10 @@
         <ReturnType>System.Type</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets the type of the associated builder.</summary>
+        <value>The type of the associated builder.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Runtime.CompilerServices/AsyncValueTaskMethodBuilder.xml b/xml/System.Runtime.CompilerServices/AsyncValueTaskMethodBuilder.xml
@@ -21,7 +21,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Represents a builder for asynchronous methods that return a <see cref="T:System.Threading.Tasks.ValueTask" />.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -64,11 +64,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -111,11 +111,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -143,8 +143,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder" /> struct.</summary>
+        <returns>The initialized instance.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -173,8 +173,8 @@
         <Parameter Name="exception" Type="System.Exception" />
       </Parameters>
       <Docs>
-        <param name="exception">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="exception">The exception to bind to the task.</param>
+        <summary>Marks the task as failed and binds the specified exception to the task.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -202,7 +202,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Marks the task as successfully completed.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -232,8 +232,8 @@
         <Parameter Name="stateMachine" Type="System.Runtime.CompilerServices.IAsyncStateMachine" />
       </Parameters>
       <Docs>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="stateMachine">The state machine instance to associate with the builder.</param>
+        <summary>Associates the builder with the specified state machine.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -270,9 +270,9 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="stateMachine">The state machine instance, passed by reference.</param>
+        <summary>Begins running the builder with the associated state machine.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -299,10 +299,10 @@
         <ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets the task for this builder.</summary>
+        <value>The task for this builder.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Runtime.CompilerServices/AsyncValueTaskMethodBuilder`1.xml b/xml/System.Runtime.CompilerServices/AsyncValueTaskMethodBuilder`1.xml
@@ -27,7 +27,7 @@
   <Interfaces />
   <Docs>
     <typeparam name="TResult">To be added.</typeparam>
-    <summary>To be added.</summary>
+    <summary>Represents a builder for asynchronous methods that returns a <see cref="T:System.Threading.Tasks.ValueTask`1" />.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -72,11 +72,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -126,11 +126,11 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TAwaiter">To be added.</typeparam>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="awaiter">To be added.</param>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="awaiter">The awaiter.</param>
+        <param name="stateMachine">The state machine.</param>
+        <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -160,8 +160,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1" /> struct.</summary>
+        <returns>The initialized instance.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -192,8 +192,8 @@
         <Parameter Name="exception" Type="System.Exception" />
       </Parameters>
       <Docs>
-        <param name="exception">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="exception">The exception to bind to the task.</param>
+        <summary>Marks the task as failed and binds the specified exception to the task.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -225,8 +225,8 @@
         <Parameter Name="result" Type="TResult" />
       </Parameters>
       <Docs>
-        <param name="result">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="result">The result to use to complete the task.</param>
+        <summary>Marks the task as successfully completed.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -258,8 +258,8 @@
         <Parameter Name="stateMachine" Type="System.Runtime.CompilerServices.IAsyncStateMachine" />
       </Parameters>
       <Docs>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="stateMachine">The state machine instance to associate with the builder.</param>
+        <summary>Associates the builder with the specified state machine.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -298,9 +298,9 @@
         <Parameter Name="stateMachine" Type="TStateMachine" RefType="ref" />
       </Parameters>
       <Docs>
-        <typeparam name="TStateMachine">To be added.</typeparam>
-        <param name="stateMachine">To be added.</param>
-        <summary>To be added.</summary>
+        <typeparam name="TStateMachine">The type of the state machine.</typeparam>
+        <param name="stateMachine">The state machine instance, passed by reference.</param>
+        <summary>Begins running the builder with the associated state machine.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -329,10 +329,10 @@
         <ReturnType>System.Threading.Tasks.ValueTask&lt;TResult&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets the task for this builder.</summary>
+        <value>The task for this builder.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
