diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLogger.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLogger.cs
index 991a383dc1ff7..e2b1cd8b264eb 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLogger.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLogger.cs
@@ -15,6 +15,9 @@ public class NullLogger : ILogger
///
public static NullLogger Instance { get; } = new NullLogger();
+ ///
+ /// Initializes a new instance of the class.
+ ///
private NullLogger()
{
}
diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderOptionsChangeTokenSource.cs b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderOptionsChangeTokenSource.cs
index 4026b8ce75817..6a1ebd0c9d746 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderOptionsChangeTokenSource.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderOptionsChangeTokenSource.cs
@@ -8,6 +8,9 @@ namespace Microsoft.Extensions.Logging.Configuration
///
public class LoggerProviderOptionsChangeTokenSource : ConfigurationChangeTokenSource
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public LoggerProviderOptionsChangeTokenSource(ILoggerProviderConfiguration providerConfiguration) : base(providerConfiguration.Configuration)
{
}
diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs
index 18978a2c40a61..7ab51ad8c1e8c 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs
@@ -12,6 +12,9 @@ namespace Microsoft.Extensions.Logging.Console
///
public class ConsoleFormatterOptions
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public ConsoleFormatterOptions() { }
///
diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs
index 1d4e9c4400117..3a542e6063635 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs
@@ -9,6 +9,9 @@
namespace Microsoft.Extensions.Logging.Console
{
+ ///
+ /// A logger that writes messages in the console.
+ ///
[UnsupportedOSPlatform("browser")]
internal sealed class ConsoleLogger : ILogger
{
@@ -38,6 +41,7 @@ internal ConsoleLogger(
[ThreadStatic]
private static StringWriter? t_stringWriter;
+ ///
public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)
{
if (!IsEnabled(logLevel))
@@ -65,11 +69,13 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except
_queueProcessor.EnqueueMessage(new LogMessageEntry(computedAnsiString, logAsError: logLevel >= Options.LogToStandardErrorThreshold));
}
+ ///
public bool IsEnabled(LogLevel logLevel)
{
return logLevel != LogLevel.None;
}
+ ///
public IDisposable BeginScope(TState state) where TState : notnull => ScopeProvider?.Push(state) ?? NullScope.Instance;
}
}
diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs
index 3603cc97e8a50..215e8598092f5 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs
@@ -10,6 +10,9 @@ namespace Microsoft.Extensions.Logging.Console
///
public class JsonConsoleFormatterOptions : ConsoleFormatterOptions
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public JsonConsoleFormatterOptions() { }
///
diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs
index e824b68739e34..2b32f919f9420 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs
@@ -8,6 +8,9 @@ namespace Microsoft.Extensions.Logging.Console
///
public class SimpleConsoleFormatterOptions : ConsoleFormatterOptions
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public SimpleConsoleFormatterOptions() { }
///
diff --git a/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerProvider.cs b/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerProvider.cs
index d434686b32a02..3f9d1afcda8d3 100644
--- a/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerProvider.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerProvider.cs
@@ -15,6 +15,7 @@ public ILogger CreateLogger(string name)
return new DebugLogger(name);
}
+ ///
public void Dispose()
{
}
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs
index e4b89bdb92569..a5d6e6a6a3c5a 100644
--- a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs
@@ -48,6 +48,9 @@ public EventLogLogger(string name, EventLogSettings settings, IExternalScopeProv
_intermediateMessageSegmentSize = EventLog.MaxMessageSize - 2 * ContinuationString.Length;
}
+ ///
+ /// The event log.
+ ///
public IEventLog EventLog { get; }
///
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs
index d2b8c924470e2..a43f74614a70a 100644
--- a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/WindowsEventLog.cs
@@ -8,6 +8,9 @@
namespace Microsoft.Extensions.Logging.EventLog
{
+ ///
+ /// The windows event log.
+ ///
[SupportedOSPlatform("windows")]
internal sealed class WindowsEventLog : IEventLog
{
@@ -15,13 +18,22 @@ internal sealed class WindowsEventLog : IEventLog
private const int MaximumMessageSize = 31839;
private bool _enabled = true;
+ ///
+ /// Initializes a new instance of the class.
+ ///
public WindowsEventLog(string logName, string machineName, string sourceName)
{
DiagnosticsEventLog = new System.Diagnostics.EventLog(logName, machineName, sourceName);
}
+ ///
+ /// The diagnostics event log.
+ ///
public System.Diagnostics.EventLog DiagnosticsEventLog { get; }
+ ///
+ /// The maximum message size.
+ ///
public int MaxMessageSize => MaximumMessageSize;
public int? DefaultEventId { get; set; }
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
index e69ad6ab3eff2..b0e405ec81020 100644
--- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
@@ -50,6 +50,7 @@ public bool IsEnabled(LogLevel logLevel)
return logLevel != LogLevel.None && logLevel >= Level;
}
+ ///
public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)
{
if (!IsEnabled(logLevel))
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerProvider.cs b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerProvider.cs
index 9c62c8f175a81..6a5343d12129e 100644
--- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerProvider.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerProvider.cs
@@ -20,6 +20,10 @@ public class EventSourceLoggerProvider : ILoggerProvider
private EventSourceLogger? _loggers; // Linked list of loggers that I have created
private readonly LoggingEventSource _eventSource;
+ ///
+ /// Creates an instance of .
+ ///
+ /// The logging event source.
public EventSourceLoggerProvider(LoggingEventSource eventSource)
{
ThrowHelper.ThrowIfNull(eventSource);
diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/TraceSourceLogger.cs b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/TraceSourceLogger.cs
index 02e93b8309317..7d94f25821f19 100644
--- a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/TraceSourceLogger.cs
+++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/TraceSourceLogger.cs
@@ -7,15 +7,23 @@
namespace Microsoft.Extensions.Logging.TraceSource
{
+ ///
+ /// A logger that writes a trace source log message.
+ ///
internal sealed class TraceSourceLogger : ILogger
{
private readonly DiagnosticsTraceSource _traceSource;
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// trace source
public TraceSourceLogger(DiagnosticsTraceSource traceSource)
{
_traceSource = traceSource;
}
+ ///
public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)
{
if (!IsEnabled(logLevel))