Improve XML docs for AddNLog and UseNLog (#710)

NLog · Dec 6, 2023 · 7948d0b · 7948d0b
1 parent 45d709d
commit 7948d0b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 11 deletions.
diff --git a/src/NLog.Extensions.Hosting/Extensions/ConfigureExtensions.cs b/src/NLog.Extensions.Hosting/Extensions/ConfigureExtensions.cs
@@ -17,8 +17,7 @@ namespace NLog.Extensions.Hosting
     public static class ConfigureExtensions
     {
         /// <summary>
-        ///     Enable and configure NLog as a logging provider for buildable generic host (.NET Core 2.1+).
-        ///     Can be used in discrete containers as well.
+        /// Enable NLog as logging provider for Microsoft Extension Logging
         /// </summary>
         /// <param name="builder"></param>
         /// <returns>IHostBuilder for chaining</returns>
@@ -29,8 +28,7 @@ public static IHostBuilder UseNLog(this IHostBuilder builder)
         }
 
         /// <summary>
-        ///     Enable and configure NLog as a logging provider for buildable generic host (.NET Core 2.1+).
-        ///     Can be used in discrete containers as well.
+        /// Enable NLog as logging provider for Microsoft Extension Logging
         /// </summary>
         /// <param name="builder"></param>
         /// <param name="options">NLogProviderOptions object to configure NLog behavior</param>

diff --git a/src/NLog.Extensions.Logging/Extensions/ConfigureExtensions.cs b/src/NLog.Extensions.Logging/Extensions/ConfigureExtensions.cs
@@ -113,21 +113,21 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, NLogProvider
         }
 
         /// <summary>
-        /// Enable NLog as logging provider for Microsoft Extension Logging
+        /// Enable NLog as logging provider for Microsoft Extension Logging, and loads the new NLog <paramref name="configuration"/>.
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="configuration">New NLog config.</param>
+        /// <param name="configuration">New NLog config to be loaded.</param>
         /// <returns>ILoggingBuilder for chaining</returns>
         public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfiguration configuration)
         {
             return AddNLog(builder, configuration, null);
         }
 
         /// <summary>
-        /// Enable NLog as logging provider for Microsoft Extension Logging
+        /// Enable NLog as logging provider for Microsoft Extension Logging, and loads the new NLog <paramref name="configuration"/>.
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="configuration">New NLog config.</param>
+        /// <param name="configuration">New NLog config to be loaded.</param>
         /// <param name="options">NLog Logging Provider options</param>
         /// <returns>ILoggingBuilder for chaining</returns>
         public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfiguration configuration, NLogProviderOptions options)
@@ -145,10 +145,10 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfi
         }
 
         /// <summary>
-        /// Enable NLog as logging provider for Microsoft Extension Logging
+        /// Enable NLog as logging provider for Microsoft Extension Logging, and loads NLog config from <paramref name="configFileRelativePath"/>
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="configFileRelativePath">relative path to NLog configuration file.</param>
+        /// <param name="configFileRelativePath">relative file-path to NLog configuration file.</param>
         /// <returns>ILoggingBuilder for chaining</returns>
         public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, string configFileRelativePath)
         {

diff --git a/src/NLog.Extensions.Logging/NLog.Extensions.Logging.csproj b/src/NLog.Extensions.Logging/NLog.Extensions.Logging.csproj
@@ -81,7 +81,7 @@ List of major changes in NLog 5.0: https://nlog-project.org/2021/08/25/nlog-5-0-
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="NLog" Version="5.2.6" />
+    <PackageReference Include="NLog" Version="5.2.7" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
   </ItemGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'net461' ">