Skip to content

Commit 942944e

Browse files
authored
fix up paramrefs - Microsoft.* namespaces (#10187)
1 parent 0d795ed commit 942944e

File tree

6 files changed

+352
-353
lines changed

6 files changed

+352
-353
lines changed

xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@
6868
</Parameters>
6969
<Docs>
7070
<param name="instanceType">The type to activate.</param>
71-
<param name="argumentTypes">
72-
The types of objects, in order, that will be passed to the returned function as its second parameter
71+
<param name="argumentTypes">
72+
The types of objects, in order, that will be passed to the returned function as its second parameter
7373
</param>
74-
<summary>Create a delegate that will instantiate a type with constructor arguments provided directly
74+
<summary>Create a delegate that will instantiate a type with constructor arguments provided directly
7575
and/or from an <see cref="T:System.IServiceProvider" />.</summary>
76-
<returns>
77-
A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider" />
78-
and an argument array containing objects matching the types defined in argumentTypes
76+
<returns>
77+
A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider" />
78+
and an argument array containing objects matching the types defined in argumentTypes
7979
.</returns>
8080
<remarks>To be added.</remarks>
8181
</Docs>
@@ -117,7 +117,7 @@
117117
<typeparam name="T">The type to activate.</typeparam>
118118
<param name="argumentTypes">The types of objects, in order, that will be passed to the returned function as its second parameter.</param>
119119
<summary>Creates a delegate that will instantiate a type with constructor arguments provided directly or from an <see cref="T:System.IServiceProvider" />.</summary>
120-
<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>
120+
<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>
121121
<remarks>To be added.</remarks>
122122
</Docs>
123123
</Member>

xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@
5656
<summary>Gets service of type <paramref name="serviceType" /> from the <see cref="T:System.IServiceProvider" /> that implements this interface.</summary>
5757
<returns>A service object of type <paramref name="serviceType" />. Throws an exception if the <see cref="T:System.IServiceProvider" /> cannot create the object.</returns>
5858
<remarks>To be added.</remarks>
59-
<exception cref="T:System.ObjectDisposedException">
60-
<paramref name="provider" /> has already been disposed.</exception>
59+
<exception cref="T:System.ObjectDisposedException">The provider has already been disposed.</exception>
6160
</Docs>
6261
</Member>
6362
</Members>

xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@
133133
<returns>The HTTP message handler chain.</returns>
134134
<remarks>To be added.</remarks>
135135
<exception cref="T:System.ArgumentNullException">
136-
<paramref name="primaryHandler " /> or <paramref name="additionalHandlers " /> is <see langword="null" />.</exception>
136+
<paramref name="primaryHandler" /> or <paramref name="additionalHandlers" /> is <see langword="null" />.</exception>
137137
<exception cref="T:System.InvalidOperationException">
138-
<paramref name="additionalHandlers " /> contains a <see langword="null" /> entry.
138+
<paramref name="additionalHandlers" /> contains a <see langword="null" /> entry.
139139

140140
-or-
141141

@@ -222,7 +222,7 @@
222222
<summary>Gets an <see cref="T:System.IServiceProvider" /> which can be used to resolve services
223223
from the dependency injection container.</summary>
224224
<value>To be added.</value>
225-
<remarks>This property is sensitive to the value of
225+
<remarks>This property is sensitive to the value of
226226
<see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope" />. If <see langword="true" /> this
227227
property will be a reference to the application's root service provider. If <see langword="false" />
228228
(default) this will be a reference to a scoped service provider that has the same

xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@
251251
</Parameters>
252252
<Docs>
253253
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
254-
<param name="includeScopes">A value which indicates whether log scope information should be displayed
254+
<param name="includeScopes">A value which indicates whether log scope information should be displayed
255255
in the output.</param>
256256
<summary>Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.Information or higher.</summary>
257257
<returns>This method is retained only for compatibility.</returns>
@@ -358,7 +358,7 @@
358358
<Docs>
359359
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
360360
<param name="minLevel">The minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel" /> to be logged.</param>
361-
<param name="includeScopes">A value which indicates whether log scope information should be displayed
361+
<param name="includeScopes">A value which indicates whether log scope information should be displayed
362362
in the output.</param>
363363
<summary>Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel" />s of minLevel or higher.</summary>
364364
<returns>This method is retained only for compatibility.</returns>
@@ -399,7 +399,7 @@
399399
<Docs>
400400
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use.</param>
401401
<param name="filter">The category filter to apply to logs.</param>
402-
<param name="includeScopes">A value which indicates whether log scope information should be displayed
402+
<param name="includeScopes">A value which indicates whether log scope information should be displayed
403403
in the output.</param>
404404
<summary>Adds a console logger that is enabled as defined by the filter function.</summary>
405405
<returns>This method is retained only for compatibility.</returns>
@@ -542,7 +542,7 @@
542542
<typeparam name="TFormatter">The custom console logger formatter.</typeparam>
543543
<typeparam name="TOptions">The configuration options.</typeparam>
544544
<param name="builder">The current logging builder instance to use.</param>
545-
<param name="configure">A delegate to configure <paramref name="TOptions" /> for the custom formatter <paramref name="TFormatter" />.</param>
545+
<param name="configure">A delegate to configure <typeparamref name="TOptions" /> for the custom formatter <typeparamref name="TFormatter" />.</param>
546546
<summary>Adds a custom console logger formatter to be configured with the specified options.</summary>
547547
<returns>The current logging builder instance so that additional calls can be chained.</returns>
548548
<remarks>To be added.</remarks>

xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ The value returned by this method can have the following meanings:
113113
<Parameter Name="y" Type="Microsoft.Extensions.Primitives.StringSegment" />
114114
</Parameters>
115115
<Docs>
116-
<param name="x">The first object of type <paramref name="T" /> to compare.</param>
117-
<param name="y">The second object of type <paramref name="T" /> to compare.</param>
116+
<param name="x">The first object of type <typeparamref name="T" /> to compare.</param>
117+
<param name="y">The second object of type <typeparamref name="T" /> to compare.</param>
118118
<summary>Determines whether the specified objects are equal.</summary>
119119
<returns>
120120
<see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>

0 commit comments

Comments
 (0)