Add XML doc comments to public API for better IntelliSense

Added <summary>, <param>, and <returns> XML documentation to all public types, methods, and properties in CallerLogContext, CallerLogContextExtensions, and FluentLoggerExtensions. Improved parameter naming consistency and added documentation for PrependCallerArgs. These changes enhance code readability and maintainability without affecting runtime behavior.

Author: olivegamestudio

CallerLogContext.cs

@@ -2,16 +2,38 @@
 
 namespace FluentLogger;
 
+/// <summary>
+/// Contains the logger and caller information.
+/// </summary>
 public readonly struct CallerLogContext
 {
+    /// <summary>
+    /// The logger instance.
+    /// </summary>
     public ILogger Logger { get; }
 
+    /// <summary>
+    /// The file path of the caller.
+    /// </summary>
     public string? File { get; }
 
+    /// <summary>
+    /// The member name of the caller.
+    /// </summary>
     public string? Member { get; }
 
+    /// <summary>
+    /// The line number of the caller.
+    /// </summary>
     public int Line { get; }
 
+    /// <summary>
+    /// The constructor.
+    /// </summary>
+    /// <param name="logger">The logger instance.</param>
+    /// <param name="file">The file path of the caller.</param>
+    /// <param name="member">The member name of the caller.</param>
+    /// <param name="line">The line number of the caller.</param>
     public CallerLogContext(ILogger logger, string? file, string? member, int line)
     {
         Logger = logger;

CallerLogContextExtensions.cs

@@ -2,32 +2,67 @@
 
 namespace FluentLogger;
 
+/// <summary>
+/// Contains extension methods for logging with caller context.
+/// </summary>
 public static class CallerLogContextExtensions
 {
+    /// <summary>
+    /// Logs an information message including caller context (file name, member name, line number).
+    /// </summary>
+    /// <param name="context">The caller log context.</param>
+    /// <param name="message">The message to log.</param>
+    /// <param name="args">The arguments for the message.</param>
     public static void LogInformation(this CallerLogContext context, string message, params object?[] args)
     {
-        string fileName = Path.GetFileName(context.File);
+        string? fileName = Path.GetFileName(context.File);
         context.Logger.LogInformation("[{File}:{Member}:{Line}] " + message, PrependCallerArgs(fileName, context.Member, context.Line, args));
     }
 
+    /// <summary>
+    /// Logs an error message including caller context (file name, member name, line number).
+    /// </summary>
+    /// <param name="context">The caller log context.</param>
+    /// <param name="message">The message to log.</param>
+    /// <param name="args">The arguments for the message.</param>
     public static void LogError(this CallerLogContext context, string message, params object?[] args)
     {
-        string fileName = Path.GetFileName(context.File);
+        string? fileName = Path.GetFileName(context.File);
         context.Logger.LogError("[{File}:{Member}:{Line}] " + message, PrependCallerArgs(fileName, context.Member, context.Line, args));
     }
 
+    /// <summary>
+    /// Logs an debug message including caller context (file name, member name, line number).
+    /// </summary>
+    /// <param name="context">The caller log context.</param>
+    /// <param name="message">The message to log.</param>
+    /// <param name="args">The arguments for the message.</param>
     public static void LogDebug(this CallerLogContext context, string message, params object?[] args)
     {
-        string fileName = Path.GetFileName(context.File);
+        string? fileName = Path.GetFileName(context.File);
         context.Logger.LogDebug("[{File}:{Member}:{Line}] " + message, PrependCallerArgs(fileName, context.Member, context.Line, args));
     }
 
-    public static void LogWarning(this CallerLogContext ctx, string message, params object?[] args)
+    /// <summary>
+    /// Logs an warning message including caller context (file name, member name, line number).
+    /// </summary>
+    /// <param name="context">The caller log context.</param>
+    /// <param name="message">The message to log.</param>
+    /// <param name="args">The arguments for the message.</param>
+    public static void LogWarning(this CallerLogContext context, string message, params object?[] args)
     {
-        string fileName = Path.GetFileName(ctx.File);
-        ctx.Logger.LogWarning("[{File}:{Member}:{Line}] " + message, PrependCallerArgs(fileName, ctx.Member, ctx.Line, args));
+        string? fileName = Path.GetFileName(context.File);
+        context.Logger.LogWarning("[{File}:{Member}:{Line}] " + message, PrependCallerArgs(fileName, context.Member, context.Line, args));
     }
 
+    /// <summary>
+    /// Prepends caller information to the arguments array.
+    /// </summary>
+    /// <param name="file">The file name of the caller.</param>
+    /// <param name="member">The member name of the caller.</param>
+    /// <param name="line">The line number of the caller.</param>
+    /// <param name="args">The original arguments array.</param>
+    /// <returns>A new arguments array with caller information prepended.</returns>
     static object?[] PrependCallerArgs(string file, string? member, int line, object?[] args)
     {
         object?[] finalArgs = new object?[args.Length + 3];

FluentLoggerExtensions.cs

@@ -5,7 +5,17 @@ namespace FluentLogger;
 
 public static class FluentLoggerExtensions
 {
+    /// <summary>
+    /// Wraps the given ILogger with caller information.
+    /// </summary>
+    /// <param name="logger">The logger instance.</param>
+    /// <param name="file">The file path of the caller.</param>
+    /// <param name="member">The member name of the caller.</param>
+    /// <param name="line">The line number of the caller.</param>
+    /// <returns>A context object containing the logger and caller information.</returns>
     public static CallerLogContext WithCaller(this ILogger logger,
-        [CallerFilePath] string? file = null, [CallerMemberName] string? member = null, [CallerLineNumber] int line = 0)
+        [CallerFilePath] string? file = null,
+        [CallerMemberName] string? member = null,
+        [CallerLineNumber] int line = 0)
         => new(logger, file, member, line);
 }