Skip to content

Commit 285f0f6

Browse files
committed
Added XML comments for a publicly exposed class
1 parent c2fee61 commit 285f0f6

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

src/Serilog.AspNetCore/AspNetCore/SerilogLoggerFactory.cs

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,49 @@
1818

1919
namespace Serilog.AspNetCore
2020
{
21-
public class SerilogLoggerFactory : ILoggerFactory
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
2226
{
2327
readonly SerilogLoggerProvider _provider;
2428

25-
public SerilogLoggerFactory(Serilog.ILogger logger = null, bool dispose = false)
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)
2635
{
2736
_provider = new SerilogLoggerProvider(logger, dispose);
2837
}
2938

30-
public void Dispose()
39+
/// <summary>
40+
/// Disposes the provider.
41+
/// </summary>
42+
public void Dispose()
3143
{
3244
_provider.Dispose();
3345
}
3446

35-
public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
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)
3655
{
3756
return _provider.CreateLogger(categoryName);
3857
}
3958

40-
public void AddProvider(ILoggerProvider provider)
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)
4164
{
4265
SelfLog.WriteLine("Ignoring added logger provider {0}", provider);
4366
}

0 commit comments

Comments
 (0)