Skip to content

Add ArgumentNullException to AddProvider #7360

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
Nov 9, 2021
Merged

Add ArgumentNullException to AddProvider #7360

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
20 changes: 11 additions & 9 deletions xml/Microsoft.Extensions.Logging/LoggerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>Produces instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> classes based on the given providers.</summary>
<summary>Produces instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> classes based on the specified providers.</summary>
Copy link
Member

Choose a reason for hiding this comment

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

@gewarren @carlossanlop - for some reason I thought the triple-slash doc comments in dotnet/runtime were now the "master". Shouldn't we be updating them instead?

https://github.com/dotnet/runtime/blob/a8ac67ae5373dce4d337012d2e8c875d32ffa638/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactory.cs#L12

Copy link
Member

Choose a reason for hiding this comment

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

They are not yet. We have only moved over 3 projects and we stopped because the porting tool has some issues. However we will try and make it the main story for .NET 7

Copy link
Member

Choose a reason for hiding this comment

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

Is the plan to port these changes to the triple-slash doc comments in the code?

Copy link
Member

Choose a reason for hiding this comment

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

We should with the doc porting tool once that is ready.

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -81,7 +81,7 @@
</Parameters>
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -110,7 +110,7 @@
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOptions">The filter options to use.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers and filter options.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -139,7 +139,7 @@
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOption">The filter option to use.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers and filter option.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -164,7 +164,7 @@
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOption">The filter option to use.</param>
<param name="options">The logger factory options.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers, filter option and logger factory options.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers, filter option, and logger factory options.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -199,8 +199,10 @@
</Parameters>
<Docs>
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to add.</param>
<summary>Adds the given provider to those used in creating <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</summary>
<summary>Adds the specified provider to the collection of providers used in creating <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="provider" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CheckDisposed">
Expand All @@ -227,7 +229,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Check if the factory has been disposed.</summary>
<summary>Checks if the factory has been disposed.</summary>
<returns>
<see langword="true" /> if <see cref="M:Microsoft.Extensions.Logging.LoggerFactory.Dispose" /> has been called; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -256,7 +258,7 @@
</Parameters>
<Docs>
<param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.</param>
<summary>Creates new instance of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> configured using provided <paramref name="configure" /> delegate.</summary>
<summary>Creates a new instance of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> that's configured using the provided <paramref name="configure" /> delegate.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> that was created.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -292,7 +294,7 @@
</Parameters>
<Docs>
<param name="categoryName">The category name for messages produced by the logger.</param>
<summary>Creates an <see cref="T:Microsoft.Extensions.Logging.ILogger" /> with the given <paramref name="categoryName" />.</summary>
<summary>Creates an <see cref="T:Microsoft.Extensions.Logging.ILogger" /> with the specified <paramref name="categoryName" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down