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

Updated xml-docs for AddNLog-methods to instead use AddNLogWeb #669

Merged
merged 1 commit into from
Jun 10, 2021
Merged

Updated xml-docs for AddNLog-methods to instead use AddNLogWeb #669

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
30 changes: 17 additions & 13 deletions src/NLog.Web.AspNetCore/AspNetExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,9 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, NLogAspNe
}

/// <summary>
/// Apply NLog configuration from XML config.
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog.config from path
/// </summary>
/// <remarks>Recommended to use AddNLogWeb() to avoid name-collission issue with NLog.Extension.Logging namespace</remarks>
/// <param name="builder">The logging builder</param>
/// <param name="configFileName">Path to NLog configuration file, e.g. nlog.config. </param>
public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, string configFileName)
Expand All @@ -144,7 +145,7 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, string confi
}

/// <summary>
/// Apply NLog configuration from XML config.
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog.config from path
/// </summary>
/// <param name="builder">The logging builder</param>
/// <param name="configFileName">Path to NLog configuration file, e.g. nlog.config. </param>
Expand All @@ -161,8 +162,9 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, string co
}

/// <summary>
/// Configure NLog from API
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog LoggingConfiguration
/// </summary>
/// <remarks>Recommended to use AddNLogWeb() to avoid name-collission issue with NLog.Extension.Logging namespace</remarks>
/// <param name="builder">The logging builder</param>
/// <param name="configuration">Config for NLog</param>
public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfiguration configuration)
Expand All @@ -171,7 +173,7 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfi
}

/// <summary>
/// Configure NLog from API
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog LoggingConfiguration
/// </summary>
/// <param name="builder">The logging builder</param>
/// <param name="configuration">Config for NLog</param>
Expand All @@ -181,8 +183,9 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, LoggingCo
}

/// <summary>
/// Configure NLog from API
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog LoggingConfiguration
/// </summary>
/// <remarks>Recommended to use AddNLogWeb() to avoid name-collission issue with NLog.Extension.Logging namespace</remarks>
/// <param name="builder">The logging builder</param>
/// <param name="configuration">Config for NLog</param>
/// <param name="options">Options for registration of the NLog LoggingProvider and enabling features.</param>
Expand All @@ -192,7 +195,7 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, LoggingConfi
}

/// <summary>
/// Configure NLog from API
/// Enable NLog as logging provider for Microsoft Extension Logging, and explicit load NLog LoggingConfiguration
/// </summary>
/// <param name="builder">The logging builder</param>
/// <param name="configuration">Config for NLog</param>
Expand All @@ -211,8 +214,9 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, LoggingCo
}

/// <summary>
/// Enable NLog as logging provider for Microsoft Extension Logging
/// Enable NLog as logging provider for Microsoft Extension Logging, and provide isolated LogFactory
/// </summary>
/// <remarks>Recommended to use AddNLogWeb() to avoid name-collission issue with NLog.Extension.Logging namespace</remarks>
/// <param name="builder"></param>
/// <param name="factoryBuilder">Initialize NLog LogFactory with NLog LoggingConfiguration.</param>
public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, Func<IServiceProvider, LogFactory> factoryBuilder)
Expand All @@ -221,7 +225,7 @@ public static ILoggingBuilder AddNLog(this ILoggingBuilder builder, Func<IServic
}

/// <summary>
/// Enable NLog as logging provider for Microsoft Extension Logging
/// Enable NLog as logging provider for Microsoft Extension Logging, and provide isolated LogFactory
/// </summary>
/// <param name="builder"></param>
/// <param name="factoryBuilder">Initialize NLog LogFactory with NLog LoggingConfiguration.</param>
Expand All @@ -239,7 +243,7 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, Func<ISer
}

/// <summary>
/// Configure NLog from API
/// Enable NLog as logging provider for Microsoft Extension Logging, and provide isolated LogFactory
/// </summary>
/// <param name="builder">The logging builder</param>
/// <param name="logFactory">NLog LogFactory</param>
Expand All @@ -256,15 +260,15 @@ public static ILoggingBuilder AddNLogWeb(this ILoggingBuilder builder, LogFactor
}

/// <summary>
/// Use NLog for Dependency Injected loggers.
/// Enable NLog as logging provider for Microsoft Extension Logging.
/// </summary>
public static IWebHostBuilder UseNLog(this IWebHostBuilder builder)
{
return UseNLog(builder, null);
}

/// <summary>
/// Use NLog for Dependency Injected loggers.
/// Enable NLog as logging provider for Microsoft Extension Logging.
/// </summary>
/// <param name="builder"></param>
/// <param name="options">Options for registration of the NLog LoggingProvider and enabling features.</param>
Expand All @@ -280,15 +284,15 @@ public static IWebHostBuilder UseNLog(this IWebHostBuilder builder, NLogAspNetCo
}

/// <summary>
/// Use NLog for Dependency Injected loggers.
/// Enable NLog as logging provider for Microsoft Extension Logging.
/// </summary>
public static IHostBuilder UseNLog(this IHostBuilder builder)
{
return UseNLog(builder, null);
}

/// <summary>
/// Use NLog for Dependency Injected loggers.
/// Enable NLog as logging provider for Microsoft Extension Logging.
/// </summary>
/// <param name="builder"></param>
/// <param name="options">Options for registration of the NLog LoggingProvider and enabling features.</param>
Expand Down