Missing XML Docs

Author: alefranz

src/MELT.AspNetCore/MELTWebApplicationFactoryExtensions.cs

@@ -5,8 +5,18 @@
 
 namespace Microsoft.AspNetCore.Mvc.Testing
 {
+    /// <summary>
+    /// Extension methods for <see cref="WebApplicationFactory{TStartup}"/> to work with test logging capabilities.
+    /// </summary>
     public static class MELTWebApplicationFactoryExtensions
     {
+        /// <summary>
+        /// Tries to get the <see cref="ITestSink"/> which is capturing the logs for the given <see cref="WebApplicationFactory{TStartup}"/>.
+        /// </summary>
+        /// <typeparam name="TStartup">The type of the startup class.</typeparam>
+        /// <param name="factory">The <see cref="WebApplicationFactory{TStartup}"/> used in the current test.</param>
+        /// <param name="testSink">The <see cref="ITestSink"/> which is capturing logs, if configured.</param>
+        /// <returns>True if the <see cref="WebApplicationFactory{TStartup}"/> has been configured to use the test logger.</returns>
         [Obsolete("The recommended alternative is " + nameof(TryGetTestLoggerSink) + "(out " + nameof(ITestLoggerSink) + ")")]
         public static bool TryGetTestSink<TStartup>(this WebApplicationFactory<TStartup> factory, out ITestSink? testSink)
             where TStartup : class
@@ -21,6 +31,12 @@ public static bool TryGetTestSink<TStartup>(this WebApplicationFactory<TStartup>
             return false;
         }
 
+        /// <summary>
+        /// Gets the <see cref="ITestSink"/> which is capturing the logs for the given <see cref="WebApplicationFactory{TStartup}"/>.
+        /// </summary>
+        /// <typeparam name="TStartup">The type of the startup class.</typeparam>
+        /// <param name="factory">The <see cref="WebApplicationFactory{TStartup}"/> used in the current test.</param>
+        /// <returns>The <see cref="ITestSink"/> which is capturing logs.</returns>
         [Obsolete("The recommended alternative is " + nameof(GetTestLoggerSink) + "()")]
         public static ITestSink GetTestSink<TStartup>(this WebApplicationFactory<TStartup> factory)
             where TStartup : class

src/MELT.AspNetCore/MELTWebHostBuilderExtensions.cs

@@ -4,6 +4,9 @@
 
 namespace Microsoft.AspNetCore.Hosting
 {
+    /// <summary>
+    /// Extension methods for <see cref="IWebHostBuilder"/> to add test logging capabilities.
+    /// </summary>
     public static class MELTWebHostBuilderExtensions
     {
         /// <summary>

src/MELT.Serilog.AspNetCore/MELTSerilogWebHostBuilderExtensions.cs

@@ -4,6 +4,9 @@
 
 namespace Microsoft.AspNetCore.Hosting
 {
+    /// <summary>
+    /// Extension methods for <see cref="IWebHostBuilder"/> to add Serilog test logging capabilities.
+    /// </summary>
     public static class MELTSerilogWebHostBuilderExtensions
     {
         /// <summary>

src/MELT.Serilog/ISerilogTestLoggerSink.cs

@@ -2,10 +2,19 @@
 
 namespace MELT
 {
+    /// <summary>
+    /// Represents a test logger sink for capturing Serilog log entries during testing.
+    /// </summary>
     public interface ISerilogTestLoggerSink
     {
+        /// <summary>
+        /// Gets the collection of captured Serilog log entries.
+        /// </summary>
         IEnumerable<SerilogLogEntry> LogEntries { get; }
 
+        /// <summary>
+        /// Clears all captured log entries.
+        /// </summary>
         void Clear();
     }
 }

src/MELT.Serilog/SerilogLogEntry.cs

@@ -7,27 +7,62 @@
 
 namespace MELT
 {
+    /// <summary>
+    /// Represents a log entry captured from Serilog during testing.
+    /// </summary>
     public class SerilogLogEntry
     {
+#pragma warning disable CS0612 // Type or member is obsolete
         private readonly WriteContext _writeContext;
+#pragma warning restore CS0612 // Type or member is obsolete
         private static readonly IReadOnlyList<LogEventPropertyValue> _emptyProperties = new LogEventPropertyValue[0];
         private string? _format;
         private IReadOnlyList<LogEventPropertyValue>? _scope;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SerilogLogEntry"/> class.
+        /// </summary>
+        /// <param name="writeContext">The write context containing log information.</param>
+        [Obsolete]
         public SerilogLogEntry(WriteContext writeContext)
         {
             _writeContext = writeContext;
         }
 
+        /// <summary>
+        /// Gets the event ID for this log entry.
+        /// </summary>
         public EventId EventId => _writeContext.EventId;
+
+        /// <summary>
+        /// Gets the exception associated with this log entry, if any.
+        /// </summary>
         public Exception? Exception => _writeContext.Exception;
+
+        /// <summary>
+        /// Gets the name of the logger that created this log entry.
+        /// </summary>
         public string LoggerName => _writeContext.LoggerName;
+
+        /// <summary>
+        /// Gets the log level of this log entry.
+        /// </summary>
         public LogLevel LogLevel => _writeContext.LogLevel;
+
+        /// <summary>
+        /// Gets the formatted log message.
+        /// </summary>
         public string? Message => _writeContext.Message;
+
+        /// <summary>
+        /// Gets the properties associated with this log entry.
+        /// </summary>
         public IReadOnlyList<KeyValuePair<string, object>> Properties => _writeContext.State as IReadOnlyList<KeyValuePair<string, object>> ?? Constants.EmptyProperties;
 
+        /// <summary>
+        /// Gets the original format of the log message before parameter substitution.
+        /// </summary>
         public string OriginalFormat => _format ??= GetFormat();
-
         private string GetFormat()
         {
             foreach (var prop in Properties)
@@ -45,9 +80,18 @@ private string GetFormat()
             return Constants.NullString;
         }
 
+        /// <summary>
+        /// Gets the scope values from Serilog log entry.
+        /// </summary>
+        /// <remarks>
+        /// This property is obsolete. Use <see cref="Scopes"/> instead.
+        /// </remarks>
         [Obsolete("The recommended alternative is " + nameof(Scopes) + ".")]
         public IReadOnlyList<LogEventPropertyValue> Scope => _scope ??= GetSerilogScopes();
 
+        /// <summary>
+        /// Gets the scope values from Serilog log entry.
+        /// </summary>
         public IReadOnlyList<LogEventPropertyValue> Scopes => _scope ??= GetSerilogScopes();
 
         private IReadOnlyList<LogEventPropertyValue> GetSerilogScopes()

src/MELT.Serilog/SerilogScope.cs

@@ -1,7 +1,14 @@
 namespace MELT
 {
+    /// <summary>
+    /// Represents a Serilog-specific logging scope for use in tests.
+    /// </summary>
     public class SerilogScope : Scope
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SerilogScope"/> class.
+        /// </summary>
+        /// <param name="scope">The scope object to capture.</param>
         public SerilogScope(object? scope) : base(scope)
         {
         }

src/MELT.Serilog/SerilogTestLoggerSinkAccessor.cs

@@ -3,6 +3,7 @@
 
 namespace MELT
 {
+    #pragma warning disable CS0612 // Type or member is obsolete
     internal class SerilogTestLoggerSinkAccessor : ISerilogTestLoggerSink
     {
         private readonly IInternalTestSink _sink;

src/MELT.Xunit/LogValuesAssert.cs

@@ -7,6 +7,9 @@
 
 namespace MELT.Xunit
 {
+    /// <summary>
+    /// Provides assertion methods for verifying logging values.
+    /// </summary>
     [Obsolete("The recommended alternative is Xunit." + nameof(LoggingAssert) + ".")]
     public static class LogValuesAssert
     {

src/MELT.Xunit/LoggingAssert.cs

@@ -9,6 +9,9 @@
 
 namespace Xunit
 {
+    /// <summary>
+    /// Provides assertion methods for verifying logging-related behaviors.
+    /// </summary>
     public static class LoggingAssert
     {
         /// <summary>

src/MELT/Helpers/MELTLoggerFactoryExtensions.cs

@@ -3,8 +3,17 @@
 
 namespace Microsoft.Extensions.Logging
 {
+    /// <summary>
+    /// Extension methods for <see cref="ILoggerFactory"/> to work with test logging capabilities.
+    /// </summary>
     public static class MELTLoggerFactoryExtensions
     {
+        /// <summary>
+        /// Gets the test logger sink from the logger factory.
+        /// </summary>
+        /// <param name="loggerFactory">The logger factory to get the sink from.</param>
+        /// <returns>The <see cref="ITestLoggerSink"/> instance associated with the factory.</returns>
+        /// <exception cref="ArgumentException">Thrown when the logger factory is not created with <see cref="TestLoggerFactory"/>.</exception>
         public static ITestLoggerSink GetTestLoggerSink(this ILoggerFactory loggerFactory)
         {
             if (loggerFactory is TestLoggerFactory testLoggerFactory) return testLoggerFactory.Sink;