Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Aug 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand All @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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;">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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;">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.Logging.Debug/DebugLogger.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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;">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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;">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.Logging/Logger`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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;">
Expand Down Expand Up @@ -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>
Expand Down
Loading