Skip to content

Commit 9cf699b

Browse files
committed
chore(expose factory): reformatting and doc update
1 parent 285f0f6 commit 9cf699b

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

src/Serilog.AspNetCore/AspNetCore/SerilogLoggerFactory.cs

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,49 +18,50 @@
1818

1919
namespace Serilog.AspNetCore
2020
{
21-
/// <summary>
22-
/// Implements Microsoft's ILoggerFactory so that we can inject Serilog Logger.
23-
/// </summary>
24-
/// <seealso cref="Microsoft.Extensions.Logging.ILoggerFactory" />
25-
public class SerilogLoggerFactory : ILoggerFactory
21+
/// <summary>
22+
/// Implements <see cref="ILoggerFactory"/> so that we can inject Serilog Logger.
23+
/// </summary>
24+
public class SerilogLoggerFactory : ILoggerFactory
2625
{
27-
readonly SerilogLoggerProvider _provider;
26+
private readonly SerilogLoggerProvider _provider;
2827

29-
/// <summary>
30-
/// Initializes a new instance of the <see cref="SerilogLoggerFactory"/> class.
31-
/// </summary>
32-
/// <param name="logger">The logger.</param>
33-
/// <param name="dispose">if set to <c>true</c> [dispose].</param>
34-
public SerilogLoggerFactory(Serilog.ILogger logger = null, bool dispose = false)
28+
/// <summary>
29+
/// Initializes a new instance of the <see cref="SerilogLoggerFactory"/> class.
30+
/// </summary>
31+
/// <param name="logger">The Serilog logger; if not supplied, the static <see cref="Serilog.Log"/> will be used.</param>
32+
/// <param name="dispose">When true, dispose <paramref name="logger"/> when the framework disposes the provider. If the
33+
/// logger is not specified but <paramref name="dispose"/> is true, the <see cref="Log.CloseAndFlush()"/> method will be
34+
/// called on the static <see cref="Log"/> class instead.</param>
35+
public SerilogLoggerFactory(ILogger logger = null, bool dispose = false)
3536
{
3637
_provider = new SerilogLoggerProvider(logger, dispose);
3738
}
3839

39-
/// <summary>
40-
/// Disposes the provider.
41-
/// </summary>
42-
public void Dispose()
40+
/// <summary>
41+
/// Disposes the provider.
42+
/// </summary>
43+
public void Dispose()
4344
{
4445
_provider.Dispose();
4546
}
4647

47-
/// <summary>
48-
/// Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.
49-
/// </summary>
50-
/// <param name="categoryName">The category name for messages produced by the logger.</param>
51-
/// <returns>
52-
/// The <see cref="T:Microsoft.Extensions.Logging.ILogger" />.
53-
/// </returns>
54-
public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
48+
/// <summary>
49+
/// Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.
50+
/// </summary>
51+
/// <param name="categoryName">The category name for messages produced by the logger.</param>
52+
/// <returns>
53+
/// The <see cref="T:Microsoft.Extensions.Logging.ILogger" />.
54+
/// </returns>
55+
public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
5556
{
5657
return _provider.CreateLogger(categoryName);
5758
}
5859

59-
/// <summary>
60-
/// Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.
61-
/// </summary>
62-
/// <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
63-
public void AddProvider(ILoggerProvider provider)
60+
/// <summary>
61+
/// Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.
62+
/// </summary>
63+
/// <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
64+
public void AddProvider(ILoggerProvider provider)
6465
{
6566
SelfLog.WriteLine("Ignoring added logger provider {0}", provider);
6667
}

0 commit comments

Comments
 (0)