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.

Sign up for GitHub

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 tags for APIs that are already fully documented #8336

Merged
merged 3 commits into from
Aug 30, 2022
Merged

Port inheritdoc tags for APIs that are already fully documented #8336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62f02a4
Port inheritdoc tags for APIs that are already fully documented, or t…
carlossanlop Aug 25, 2022
abb89f3
Update xml/System.Runtime.Serialization/ImportOptions.xml
carlossanlop Aug 30, 2022
914ecb3
Apply suggestions from code review
carlossanlop Aug 30, 2022
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
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@
<summary>Creates or overwrites an entry in the cache.</summary>
<returns>The newly created <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instance.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down Expand Up @@ -368,6 +369,7 @@
<param name="key">An object identifying the entry.</param>
<summary>Removes the object associated with the given key.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="TryGetValue">
Expand Down Expand Up @@ -409,6 +411,7 @@
<returns>
<see langword="true" /> if the key was found.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,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="GetChildKeys">
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,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 Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,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="Dispose">
Expand Down
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
<summary>Creates a container builder from an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.</summary>
<returns>A container builder that can be used to create an <see cref="T:System.IServiceProvider" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="CreateServiceProvider">
Expand Down Expand Up @@ -155,6 +156,7 @@
<summary>Creates an <see cref="T:System.IServiceProvider" /> from the container builder.</summary>
<returns>The newly created service provider.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,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 Down Expand Up @@ -99,6 +100,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="GetService">
Expand Down
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
<value>
<see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="IsDirectory">
Expand Down Expand Up @@ -261,6 +262,7 @@
<summary>Gets the name of the file or directory, excluding the path.</summary>
<value>The name of the file or directory.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PhysicalPath">
Expand Down Expand Up @@ -294,6 +296,7 @@
<summary>Gets the full path to the file, including the file name.</summary>
<value>The full path to the file, or <see langword="null" /> if the file is not directly accessible.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
6 changes: 6 additions & 0 deletions xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ The caller should dispose the stream when done with it.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Exists">
Expand Down Expand Up @@ -134,6 +135,7 @@ The caller should dispose the stream when done with it.
<value>
<see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="IsDirectory">
Expand Down Expand Up @@ -200,6 +202,7 @@ The caller should dispose the stream when done with it.
<summary>Gets the last time the file was modified.</summary>
<value>A datetime offset representing the last time the file was modified.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Length">
Expand Down Expand Up @@ -233,6 +236,7 @@ The caller should dispose the stream when done with it.
<summary>The length of the file in bytes, or -1 for a directory or non-existing files.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Name">
Expand Down Expand Up @@ -266,6 +270,7 @@ The caller should dispose the stream when done with it.
<summary>The name of the file or directory, not including any path.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PhysicalPath">
Expand Down Expand Up @@ -299,6 +304,7 @@ The caller should dispose the stream when done with it.
<summary>The path to the file, including the file name. Return <see langword="null" /> if the file is not directly accessible.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@
<value>
<see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetLastWriteUtc">
Expand Down Expand Up @@ -158,6 +159,7 @@
<value>
<see langword="true" /> if a change has occurred; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback">
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ This member is an explicit interface member implementation. It can be used only

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,7 @@
<summary>The name of the file or directory, not including any path.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PhysicalPath">
Expand Down
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.Hosting.Systemd/SystemdNotifier.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
<value>
<see langword="true" /> if systemd is configured to receive service notifications; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Notify">
Expand Down Expand Up @@ -93,6 +94,7 @@
<param name="state">The service state to notify.</param>
<summary>Sends a notification to systemd.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.Logging.Abstractions/NullLoggerProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,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 @@ -99,6 +100,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
2 changes: 2 additions & 0 deletions xml/Microsoft.Extensions.Logging.EventSource/EventSourceLoggerProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,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 @@ -118,6 +119,7 @@
<Docs>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Logging.TraceSource/TraceSourceLoggerProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@
<Docs>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Logging/LoggerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@
<Docs>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<value>
<see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="HasChanged">
Expand Down Expand Up @@ -127,6 +128,7 @@
<value>
<see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="RegisterChangeCallback">
Expand Down Expand Up @@ -167,6 +169,7 @@
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
3 changes: 3 additions & 0 deletions xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
<value>
<see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ChangeTokens">
Expand Down Expand Up @@ -147,6 +148,7 @@
<value>
<see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="RegisterChangeCallback">
Expand Down Expand Up @@ -185,6 +187,7 @@
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Buffers/ReadOnlySequence`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -903,6 +903,7 @@
<summary>Returns a string that represents the current sequence.</summary>
<returns>A string that represents the current sequence.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="TryGet">
Expand Down
3 changes: 3 additions & 0 deletions xml/System.CodeDom.Compiler/IndentedTextWriter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous dispose operation.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Encoding">
Expand Down Expand Up @@ -446,6 +447,7 @@
<summary>Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously and causes any buffered data to be written to the underlying device.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Indent">
Expand Down Expand Up @@ -2321,6 +2323,7 @@
<summary>Asynchronously writes the line terminator to the underlying <see cref="T:System.IO.TextWriter" />.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous line writing operation.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="WriteLineAsync">
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Net.Http.Headers/HeaderStringValues+Enumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Dispose">
Expand All @@ -77,6 +78,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="MoveNext">
Expand Down Expand Up @@ -104,6 +106,7 @@
<returns>
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Current">
Expand Down Expand Up @@ -137,6 +140,7 @@ This member is an explicit interface member implementation. It can be used only

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Reset">
Expand Down Expand Up @@ -170,6 +174,7 @@ This member is an explicit interface member implementation. It can be used only

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Net.Http.Headers/HeaderStringValues.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,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="System.Collections.IEnumerable.GetEnumerator">
Expand Down Expand Up @@ -144,6 +145,7 @@ This member is an explicit interface member implementation. It can be used only

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
Loading