Skip to content

Fix up paramrefs - Microsoft.* namespaces #10187

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

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Fix up paramrefs - Microsoft.* namespaces #10187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml
View file
Original file line number Diff line number Diff line change
@@ -68,14 +68,14 @@
</Parameters>
<Docs>
<param name="instanceType">The type to activate.</param>
<param name="argumentTypes">
The types of objects, in order, that will be passed to the returned function as its second parameter
<param name="argumentTypes">
The types of objects, in order, that will be passed to the returned function as its second parameter
</param>
<summary>Create a delegate that will instantiate a type with constructor arguments provided directly
<summary>Create a delegate that will instantiate a type with constructor arguments provided directly
and/or from an <see cref="T:System.IServiceProvider" />.</summary>
<returns>
A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider" />
and an argument array containing objects matching the types defined in argumentTypes
<returns>
A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider" />
and an argument array containing objects matching the types defined in argumentTypes
.</returns>
<remarks>To be added.</remarks>
</Docs>
@@ -117,7 +117,7 @@
<typeparam name="T">The type to activate.</typeparam>
<param name="argumentTypes">The types of objects, in order, that will be passed to the returned function as its second parameter.</param>
<summary>Creates a delegate that will instantiate a type with constructor arguments provided directly or from an <see cref="T:System.IServiceProvider" />.</summary>
<returns>A factory that will instantiate type <paramref name="T" /> using an <see cref="T:System.IServiceProvider" /> and an argument array containing objects matching the types defined in <paramref name="argumentTypes" />.</returns>
<returns>A factory that will instantiate type <typeparamref name="T" /> using an <see cref="T:System.IServiceProvider" /> and an argument array containing objects matching the types defined in <paramref name="argumentTypes" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
3 changes: 1 addition & 2 deletions xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml
View file
Original file line number Diff line number Diff line change
@@ -56,8 +56,7 @@
<summary>Gets service of type <paramref name="serviceType" /> from the <see cref="T:System.IServiceProvider" /> that implements this interface.</summary>
<returns>A service object of type <paramref name="serviceType" />. Throws an exception if the <see cref="T:System.IServiceProvider" /> cannot create the object.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">
<paramref name="provider" /> has already been disposed.</exception>
<exception cref="T:System.ObjectDisposedException">The provider has already been disposed.</exception>
</Docs>
</Member>
</Members>
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml
View file
Original file line number Diff line number Diff line change
@@ -133,9 +133,9 @@
<returns>The HTTP message handler chain.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="primaryHandler " /> or <paramref name="additionalHandlers " /> is <see langword="null" />.</exception>
<paramref name="primaryHandler" /> or <paramref name="additionalHandlers" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="additionalHandlers " /> contains a <see langword="null" /> entry.
<paramref name="additionalHandlers" /> contains a <see langword="null" /> entry.

-or-

@@ -222,7 +222,7 @@
<summary>Gets an <see cref="T:System.IServiceProvider" /> which can be used to resolve services
from the dependency injection container.</summary>
<value>To be added.</value>
<remarks>This property is sensitive to the value of
<remarks>This property is sensitive to the value of
<see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope" />. If <see langword="true" /> this
property will be a reference to the application's root service provider. If <see langword="false" />
(default) this will be a reference to a scoped service provider that has the same
8 changes: 4 additions & 4 deletions xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml
View file
Original file line number Diff line number Diff line change
@@ -251,7 +251,7 @@
</Parameters>
<Docs>
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
<param name="includeScopes">A value which indicates whether log scope information should be displayed
<param name="includeScopes">A value which indicates whether log scope information should be displayed
in the output.</param>
<summary>Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.Information or higher.</summary>
<returns>This method is retained only for compatibility.</returns>
@@ -358,7 +358,7 @@
<Docs>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chriscormar.87@icloud.com

<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
<param name="minLevel">The minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel" /> to be logged.</param>
<param name="includeScopes">A value which indicates whether log scope information should be displayed
<param name="includeScopes">A value which indicates whether log scope information should be displayed
in the output.</param>
<summary>Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel" />s of minLevel or higher.</summary>
<returns>This method is retained only for compatibility.</returns>
@@ -399,7 +399,7 @@
<Docs>
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
<param name="filter">The category filter to apply to logs.</param>
<param name="includeScopes">A value which indicates whether log scope information should be displayed
<param name="includeScopes">A value which indicates whether log scope information should be displayed
in the output.</param>
<summary>Adds a console logger that is enabled as defined by the filter function.</summary>
<returns>This method is retained only for compatibility.</returns>
@@ -542,7 +542,7 @@
<typeparam name="TFormatter">The custom console logger formatter.</typeparam>
<typeparam name="TOptions">The configuration options.</typeparam>
<param name="builder">The current logging builder instance to use.</param>
<param name="configure">A delegate to configure <paramref name="TOptions" /> for the custom formatter <paramref name="TFormatter" />.</param>
<param name="configure">A delegate to configure <typeparamref name="TOptions" /> for the custom formatter <typeparamref name="TFormatter" />.</param>
<summary>Adds a custom console logger formatter to be configured with the specified options.</summary>
<returns>The current logging builder instance so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml
View file
Original file line number Diff line number Diff line change
@@ -113,8 +113,8 @@ The value returned by this method can have the following meanings:
<Parameter Name="y" Type="Microsoft.Extensions.Primitives.StringSegment" />
</Parameters>
<Docs>
<param name="x">The first object of type <paramref name="T" /> to compare.</param>
<param name="y">The second object of type <paramref name="T" /> to compare.</param>
<param name="x">The first object of type <typeparamref name="T" /> to compare.</param>
<param name="y">The second object of type <typeparamref name="T" /> to compare.</param>
<summary>Determines whether the specified objects are equal.</summary>
<returns>
<see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>
Loading