Port missing docs for GA (#8478)

carlossanlop · gewarren · web-flow · commit 36f68f364c4a · 2022-10-10T12:37:51.000-07:00
* Microsoft.Extensions.Options

* Microsoft.Extensions.Primitives

* System.Security.Cryptography

* System.Runtime.Intrinsics

* Apply suggestions from code review

Co-authored-by: Genevieve Warren &lt;24882762+gewarren@users.noreply.github.com&gt;

Co-authored-by: carlossanlop &lt;carlossanlop@users.noreply.github.com&gt;
Co-authored-by: Genevieve Warren &lt;24882762+gewarren@users.noreply.github.com&gt;
diff --git a/xml/Microsoft.Extensions.Options/IConfigureNamedOptions`1.xml b/xml/Microsoft.Extensions.Options/IConfigureNamedOptions`1.xml
@@ -30,8 +30,7 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <typeparam name="TOptions">
-    </typeparam>
+    <typeparam name="TOptions">The options type being configured.</typeparam>
     <summary>Represents something that configures the <typeparamref name="TOptions" /> type.</summary>
     <remarks>To be added.</remarks>
   </Docs>
diff --git a/xml/Microsoft.Extensions.Options/IConfigureOptions`1.xml b/xml/Microsoft.Extensions.Options/IConfigureOptions`1.xml
@@ -28,8 +28,7 @@
   </TypeParameters>
   <Interfaces />
   <Docs>
-    <typeparam name="TOptions">
-    </typeparam>
+    <typeparam name="TOptions">The options type being configured.</typeparam>
     <summary>Represents something that configures the <typeparamref name="TOptions" /> type.
             Note: These are run before all <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
     <remarks>To be added.</remarks>
diff --git a/xml/Microsoft.Extensions.Options/IOptionsFactory`1.xml b/xml/Microsoft.Extensions.Options/IOptionsFactory`1.xml
@@ -67,9 +67,9 @@
         <Parameter Name="name" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance to create.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
-        <returns>To be added.</returns>
+        <returns>The created <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Options/IOptionsMonitor`1.xml b/xml/Microsoft.Extensions.Options/IOptionsMonitor`1.xml
@@ -93,9 +93,9 @@
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;dotnet-plat-ext-6.0;dotnet-plat-ext-7.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance, if a <see langword="null" /> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" /> is used.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
-        <returns>To be added.</returns>
+        <returns>The <typeparamref name="TOptions" /> instance that matches the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Options/IOptionsSnapshot`1.xml b/xml/Microsoft.Extensions.Options/IOptionsSnapshot`1.xml
@@ -76,9 +76,9 @@
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;dotnet-plat-ext-6.0;dotnet-plat-ext-7.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance, if <see langword="null" /> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" /> is used.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
-        <returns>To be added.</returns>
+        <returns>The <typeparamref name="TOptions" /> instance that matches the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml b/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml
@@ -402,7 +402,7 @@
       <Docs>
         <param name="configureOptions">The action used to configure the options.</param>
         <summary>Registers an action used to configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
-        <returns>To be added.</returns>
+        <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Options/OptionsFactory`1.xml b/xml/Microsoft.Extensions.Options/OptionsFactory`1.xml
@@ -139,10 +139,12 @@
         <Parameter Name="name" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance to create.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
-        <returns>To be added.</returns>
+        <returns>The created <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance being created.</exception>
+        <exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="CreateInstance">
@@ -166,10 +168,11 @@
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0;dotnet-plat-ext-6.0;dotnet-plat-ext-7.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance to create.</param>
         <summary>Creates a new instance of a <typeparamref name="TOptions" /> object using the specified <paramref name="name" />.</summary>
         <returns>A <typeparamref name="TOptions" /> instance.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
       </Docs>
     </Member>
   </Members>
diff --git a/xml/Microsoft.Extensions.Options/OptionsManager`1.xml b/xml/Microsoft.Extensions.Options/OptionsManager`1.xml
@@ -139,10 +139,12 @@
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;dotnet-plat-ext-6.0;dotnet-plat-ext-7.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance, if a <see langword="null" /> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" /> is used.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
-        <returns>To be added.</returns>
+        <returns>The <typeparamref name="TOptions" /> instance that matches the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance been created.</exception>
+        <exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="Value">
diff --git a/xml/Microsoft.Extensions.Options/OptionsMonitorExtensions.xml b/xml/Microsoft.Extensions.Options/OptionsMonitorExtensions.xml
@@ -63,8 +63,8 @@
         <Parameter Name="listener" Type="System.Action&lt;TOptions&gt;" />
       </Parameters>
       <Docs>
-        <typeparam name="TOptions">To be added.</typeparam>
-        <param name="monitor">The IOptionsMonitor.</param>
+        <typeparam name="TOptions">The type of options instance being monitored.</typeparam>
+        <param name="monitor">The options monitor.</param>
         <param name="listener">The action to be invoked when <typeparamref name="TOptions" /> has changed.</param>
         <summary>Registers a listener to be called whenever <typeparamref name="TOptions" /> changes.</summary>
         <returns>An <see cref="T:System.IDisposable" /> which should be disposed to stop listening for changes.</returns>
diff --git a/xml/Microsoft.Extensions.Options/OptionsMonitor`1.xml b/xml/Microsoft.Extensions.Options/OptionsMonitor`1.xml
@@ -144,6 +144,8 @@
         <summary>The present value of the options.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance been created.</exception>
+        <exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -204,10 +206,12 @@
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;dotnet-plat-ext-6.0;dotnet-plat-ext-7.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
+        <param name="name">The name of the <typeparamref name="TOptions" /> instance, if a <see langword="null" /> <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" /> is used.</param>
         <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
-        <returns>To be added.</returns>
+        <returns>The <typeparamref name="TOptions" /> instance that matches the given <paramref name="name" />.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance been created.</exception>
+        <exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="OnChange">
diff --git a/xml/Microsoft.Extensions.Primitives/Extensions.xml b/xml/Microsoft.Extensions.Primitives/Extensions.xml
@@ -21,7 +21,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Provides extensions methods for the <see cref="N:Microsoft.Extensions.Primitives" /> namespace.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
diff --git a/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml b/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml
@@ -33,7 +33,7 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Compares two <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> objects.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -182,7 +182,7 @@ The value returned by this method can have the following meanings:
         <ReturnType>Microsoft.Extensions.Primitives.StringSegmentComparer</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets a <see cref="T:Microsoft.Extensions.Primitives.StringSegmentComparer" /> object that performs a case-sensitive ordinal <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> comparison.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -210,7 +210,7 @@ The value returned by this method can have the following meanings:
         <ReturnType>Microsoft.Extensions.Primitives.StringSegmentComparer</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets a <see cref="T:Microsoft.Extensions.Primitives.StringSegmentComparer" /> object that performs a case-insensitive ordinal <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> comparison.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
diff --git a/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml b/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml
@@ -33,7 +33,7 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Enumerates the <see cref="T:System.String" /> tokens represented by <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -62,8 +62,9 @@
         <Parameter Name="tokenizer" Type="Microsoft.Extensions.Primitives.StringTokenizer" RefType="ref" />
       </Parameters>
       <Docs>
-        <param name="tokenizer">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="tokenizer">
+          A <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer" /> that contains the value to enumerate and token separators.</param>
+        <summary>Initializes an <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator" /> using a <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml b/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml
@@ -129,8 +129,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator" />.</summary>
+        <returns>An <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator" /> based on the <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer" />'s value and separators.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml b/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml
@@ -62,8 +62,8 @@
         <Parameter Name="values" Type="Microsoft.Extensions.Primitives.StringValues" RefType="ref" />
       </Parameters>
       <Docs>
-        <param name="values">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="values">The <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> to enumerate.</param>
+        <summary>Instantiates an <see cref="T:Microsoft.Extensions.Primitives.StringValues.Enumerator" /> using a <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/Microsoft.Extensions.Primitives/StringValues.xml b/xml/Microsoft.Extensions.Primitives/StringValues.xml
@@ -721,8 +721,8 @@ In application code, this field is most commonly used to safely represent a <xre
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Returns a hash code for this instance.</summary>
+        <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>
diff --git a/xml/System.Runtime.Intrinsics/Vector128.xml b/xml/System.Runtime.Intrinsics/Vector128.xml
diff --git a/xml/System.Runtime.Intrinsics/Vector128`1.xml b/xml/System.Runtime.Intrinsics/Vector128`1.xml
diff --git a/xml/System.Runtime.Intrinsics/Vector256.xml b/xml/System.Runtime.Intrinsics/Vector256.xml
diff --git a/xml/System.Runtime.Intrinsics/Vector256`1.xml b/xml/System.Runtime.Intrinsics/Vector256`1.xml
diff --git a/xml/System.Runtime.Intrinsics/Vector64.xml b/xml/System.Runtime.Intrinsics/Vector64.xml
diff --git a/xml/System.Runtime.Intrinsics/Vector64`1.xml b/xml/System.Runtime.Intrinsics/Vector64`1.xml
diff --git a/xml/System.Security.Cryptography/RSACng.xml b/xml/System.Security.Cryptography/RSACng.xml
