Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve XML docs for AddNLog and UseNLog #710

Merged
merged 1 commit into from
Dec 6, 2023
Merged

Improve XML docs for AddNLog and UseNLog #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/NLog.Extensions.Hosting/Extensions/ConfigureExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
12 changes: 6 additions & 6 deletions src/NLog.Extensions.Logging/Extensions/ConfigureExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/NLog.Extensions.Logging/NLog.Extensions.Logging.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' ">
Expand Down