Automatic port of Microsoft.Extensions.ObjectPool docs (dotnet#4932)

* Automatic port of Microsoft.Extensions.ObjectPool docs

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>

Author: carlossanlop

xml/Microsoft.Extensions.ObjectPool/DefaultPooledObjectPolicy`1.xml

@@ -100,8 +100,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates a <typeparamref name="T" />.</summary>
+        <returns>The <typeparamref name="T" /> that was created.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -138,9 +138,10 @@
         <Parameter Name="obj" Type="T" />
       </Parameters>
       <Docs>
-        <param name="obj">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="obj">The object to return to the pool.</param>
+        <summary>Runs some processing when an object is returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.</summary>
+        <returns>
+          <see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible or desirable for the pool to keep the object.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

xml/Microsoft.Extensions.ObjectPool/PooledObjectPolicy`1.xml

@@ -72,8 +72,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates a <typeparamref name="T" />.</summary>
+        <returns>The <typeparamref name="T" /> that was created.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -102,9 +102,10 @@
         <Parameter Name="obj" Type="T" />
       </Parameters>
       <Docs>
-        <param name="obj">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="obj">The object to return to the pool.</param>
+        <summary>Runs some processing when an object is returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.</summary>
+        <returns>
+          <see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible or desirable for the pool to keep the object.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

xml/Microsoft.Extensions.ObjectPool/StringBuilderPooledObjectPolicy.xml

@@ -91,8 +91,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates a <typeparamref name="T" />.</summary>
+        <returns>The <typeparamref name="T" /> that was created.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -183,9 +183,10 @@
         <Parameter Name="obj" Type="System.Text.StringBuilder" />
       </Parameters>
       <Docs>
-        <param name="obj">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="obj">The object to return to the pool.</param>
+        <summary>Runs some processing when an object is returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.</summary>
+        <returns>
+          <see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible or desirable for the pool to keep the object.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>