Document System.Collections.Generic.CollectionExtensions (#3459)

Author: carlossanlop

xml/System.Collections.Generic/CollectionExtensions.xml

@@ -19,7 +19,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Provides extension methods for generic collections.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -52,13 +52,14 @@
         <Parameter Name="key" Type="TKey" />
       </Parameters>
       <Docs>
-        <typeparam name="TKey">To be added.</typeparam>
-        <typeparam name="TValue">To be added.</typeparam>
-        <param name="dictionary">To be added.</param>
-        <param name="key">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
+        <typeparam name="TValue">The type of the values in the dictionary.</typeparam>
+        <param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
+        <param name="key">The key of the value to get.</param>
+        <summary>Tries to get the value associated with the specified <paramref name="key" /> in the <paramref name="dictionary" />.</summary>
+        <returns>A <typeparamref name="TValue" /> instance. When the method is successful, the returned object is the value associated with the specified <paramref name="key" />. When the method fails, it returns the <see langword="default" /> value for <typeparamref name="TValue" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetValueOrDefault&lt;TKey,TValue&gt;">
@@ -91,14 +92,15 @@
         <Parameter Name="defaultValue" Type="TValue" />
       </Parameters>
       <Docs>
-        <typeparam name="TKey">To be added.</typeparam>
-        <typeparam name="TValue">To be added.</typeparam>
-        <param name="dictionary">To be added.</param>
-        <param name="key">To be added.</param>
-        <param name="defaultValue">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
+        <typeparam name="TValue">The type of the values in the dictionary.</typeparam>
+        <param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
+        <param name="key">The key of the value to get.</param>
+        <param name="defaultValue">The default value to return when the <paramref name="dictionary" /> cannot find a value associated with the specified <paramref name="key" />.</param>
+        <summary>Tries to get the value associated with the specified key in the <paramref name="dictionary" />.</summary>
+        <returns>A <typeparamref name="TValue" /> instance. When the method is successful, the returned object is the value associated with the specified <paramref name="key" />. When the method fails, it returns <paramref name="defaultValue" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="Remove&lt;TKey,TValue&gt;">
@@ -131,14 +133,15 @@
         <Parameter Name="value" Type="TValue" RefType="out" />
       </Parameters>
       <Docs>
-        <typeparam name="TKey">To be added.</typeparam>
-        <typeparam name="TValue">To be added.</typeparam>
-        <param name="dictionary">To be added.</param>
-        <param name="key">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <typeparam name="TKey">The type of the keys in the <paramref name="dictionary" />.</typeparam>
+        <typeparam name="TValue">The type of the values in the <paramref name="dictionary" />.</typeparam>
+        <param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
+        <param name="key">The key of the value to remove.</param>
+        <param name="value">When this method returns <see langword="true" />, the removed value; when this method returns <see langword="false" />, the <see langword="default" /> value for <typeparamref name="TValue" />.</param>
+        <summary>Tries to remove the value with the specified <paramref name="key" /> from the <paramref name="dictionary" />.</summary>
+        <returns><see langword="true" /> when a value is found in the <paramref name="dictionary" /> with the specified <paramref name="key" />; <see langword="false" /> when the <paramref name="dictionary" /> cannot find a value associated with the specified <paramref name="key" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryAdd&lt;TKey,TValue&gt;">
@@ -171,14 +174,15 @@
         <Parameter Name="value" Type="TValue" />
       </Parameters>
       <Docs>
-        <typeparam name="TKey">To be added.</typeparam>
-        <typeparam name="TValue">To be added.</typeparam>
-        <param name="dictionary">To be added.</param>
-        <param name="key">To be added.</param>
-        <param name="value">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
+        <typeparam name="TValue">The type of the values in the dictionary.</typeparam>
+        <param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
+        <param name="key">The key of the value to add.</param>
+        <param name="value">The value to add.</param>
+        <summary>Tries to add the specified <paramref name="key" /> and <paramref name="value" /> to the <paramref name="dictionary" />.</summary>
+        <returns><see langword="true" /> when the <paramref name="key" /> and <paramref name="value" /> are successfully added to the <paramref name="dictionary" />; <see langword="false" /> when the <paramref name="dictionary" /> already contains the specified <paramref name="key" />, in which case nothing gets added.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
       </Docs>
     </Member>
   </Members>