Port inheritdoc tag for runtime APIs that are missing docs (#8335)

* APIs with inheritdoc and at least one "To be added." (excluding remarks or value). * Change QuickStream.*Async inheritdoc cref to IStream.*Async * Apply suggestions from code review * Apply suggestions from code review * Missed one Co-authored-by: carlossanlop <[email protected]>
dotnet · Aug 28, 2022 · b003f61 · b003f61
1 parent c0bed44
commit b003f61
Show file tree

Hide file tree

Showing 46 changed files with 976 additions and 0 deletions.
diff --git a/xml/Microsoft.Extensions.Configuration/ConfigurationManager.xml b/xml/Microsoft.Extensions.Configuration/ConfigurationManager.xml
@@ -74,6 +74,7 @@
       <Docs>
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="GetChildren">
@@ -100,6 +101,7 @@
         <summary>Gets the immediate descendant configuration subsections.</summary>
         <returns>The configuration subsections.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="GetSection">
@@ -129,6 +131,7 @@
         <summary>Gets a configuration subsection with the specified key.</summary>
         <returns>The configuration section for the specified key.</returns>
         <remarks>The name of the configuration section is case-insensitive.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Item">
@@ -159,6 +162,7 @@
         <summary>Gets or sets a configuration value.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
@@ -364,6 +368,7 @@
         <summary>Gets the sources used to obtain configuration values.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml b/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml
@@ -81,6 +81,7 @@
       <Docs>
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="DisposeAsync">
@@ -107,6 +108,7 @@
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
         <returns>A task that represents the asynchronous dispose operation.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="ServiceProvider">
@@ -132,6 +134,7 @@
         <summary>The <see cref="T:System.IServiceProvider" /> used to resolve dependencies from the scope.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml
@@ -123,6 +123,7 @@
       <Docs>
         <summary>Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Contains">
@@ -165,6 +166,7 @@
         <returns>
           <see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="CopyTo">
@@ -207,6 +209,7 @@
         <param name="arrayIndex">To be added.</param>
         <summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Count">
@@ -244,6 +247,7 @@
         <summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="GetEnumerator">
@@ -282,6 +286,7 @@
         <summary>Returns an enumerator that iterates through the collection.</summary>
         <returns>An enumerator that can be used to iterate through the collection.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="IndexOf">
@@ -323,6 +328,7 @@
         <summary>Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.</summary>
         <returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Insert">
@@ -365,6 +371,7 @@
         <param name="item">To be added.</param>
         <summary>Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="IsReadOnly">
@@ -402,6 +409,7 @@
         <summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Item">
@@ -443,6 +451,7 @@
         <summary>Gets or sets the element at the specified index.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="MakeReadOnly">
@@ -517,6 +526,7 @@ After the collection is marked as read-only, any further attempt to modify it th
         <returns>
           <see langword="true" /> if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="RemoveAt">
@@ -557,6 +567,7 @@ After the collection is marked as read-only, any further attempt to modify it th
         <param name="index">To be added.</param>
         <summary>Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="System.Collections.Generic.ICollection&lt;Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;.Add">

diff --git a/xml/Microsoft.Extensions.Logging.Abstractions/NullLogger.xml b/xml/Microsoft.Extensions.Logging.Abstractions/NullLogger.xml
@@ -68,6 +68,7 @@
         <summary>Begins a logical operation scope.</summary>
         <returns>A disposable object that ends the logical operation scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Instance">
@@ -134,6 +135,7 @@
         <returns>
           <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Log&lt;TState&gt;">
@@ -182,6 +184,7 @@
         <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
         <summary>Writes a log entry.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Abstractions/NullLoggerFactory.xml b/xml/Microsoft.Extensions.Logging.Abstractions/NullLoggerFactory.xml
@@ -89,6 +89,7 @@
         <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
         <summary>Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.</summary>
         <remarks>This method ignores the parameter and does nothing.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="CreateLogger">
@@ -124,6 +125,7 @@
         <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
         <returns>A new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</returns>
         <remarks>This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" /> instance which logs nothing.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -155,6 +157,7 @@
       <Docs>
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Instance">

diff --git a/xml/Microsoft.Extensions.Logging.Abstractions/NullLogger`1.xml b/xml/Microsoft.Extensions.Logging.Abstractions/NullLogger`1.xml
@@ -98,6 +98,7 @@
         <summary>Begins a logical operation scope.</summary>
         <returns>A disposable object that ends the logical operation scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Instance">
@@ -161,6 +162,7 @@
         <returns>
           <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Log&lt;TState&gt;">
@@ -208,6 +210,7 @@
         <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
         <summary>Writes a log entry.</summary>
         <remarks>This method ignores the parameters and does nothing.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml
@@ -237,6 +237,7 @@
         <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
         <returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -270,6 +271,7 @@
       <Docs>
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="SetScopeProvider">
@@ -303,6 +305,7 @@
         <param name="scopeProvider">The provider of scope data.</param>
         <summary>Sets external scope information source for logger provider.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Debug/DebugLogger.xml b/xml/Microsoft.Extensions.Logging.Debug/DebugLogger.xml
@@ -112,6 +112,7 @@
         <summary>Begins a logical operation scope.</summary>
         <returns>A disposable object that ends the logical operation scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="IsEnabled">
@@ -145,6 +146,7 @@
         <returns>
           <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Log&lt;TState&gt;">
@@ -188,6 +190,7 @@
         <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
         <summary>Writes a log entry.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Debug/DebugLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.Debug/DebugLoggerProvider.xml
@@ -130,6 +130,7 @@
         <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
         <returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Dispose">

diff --git a/xml/Microsoft.Extensions.Logging.EventLog/EventLogLogger.xml b/xml/Microsoft.Extensions.Logging.EventLog/EventLogLogger.xml
@@ -144,6 +144,7 @@
         <summary>Begins a logical operation scope.</summary>
         <returns>A disposable object that ends the logical operation scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="EventLog">
@@ -202,6 +203,7 @@
         <returns>
           <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Log&lt;TState&gt;">
@@ -245,6 +247,7 @@
         <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
         <summary>Writes a log entry.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.EventLog/EventLogLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.EventLog/EventLogLoggerProvider.xml
@@ -165,6 +165,7 @@
         <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
         <returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -198,6 +199,7 @@
       <Docs>
         <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="SetScopeProvider">
@@ -231,6 +233,7 @@
         <param name="scopeProvider">The provider of scope data.</param>
         <summary>Sets external scope information source for logger provider.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging/LoggerExternalScopeProvider.xml b/xml/Microsoft.Extensions.Logging/LoggerExternalScopeProvider.xml
@@ -90,6 +90,7 @@
         <summary>Executes callback for each currently active scope objects in order of creation.
  All callbacks are guaranteed to be called inline from this method.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Push">
@@ -125,6 +126,7 @@
         <summary>Adds scope object to the list.</summary>
         <returns>The <see cref="T:System.IDisposable" /> token that removes scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging/Logger`1.xml b/xml/Microsoft.Extensions.Logging/Logger`1.xml
@@ -109,6 +109,7 @@
         <summary>Begins a logical operation scope.</summary>
         <returns>A disposable object that ends the logical operation scope on dispose.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
     <Member MemberName="Microsoft.Extensions.Logging.ILogger.IsEnabled">
@@ -147,6 +148,7 @@
         <returns>
           <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
+        <inheritdoc cref="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)"/>
       </Docs>
     </Member>
     <Member MemberName="Microsoft.Extensions.Logging.ILogger.Log&lt;TState&gt;">
@@ -195,6 +197,7 @@
         <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
         <summary>Writes a log entry.</summary>
         <remarks>To be added.</remarks>
+        <inheritdoc />
       </Docs>
     </Member>
   </Members>