From d1d40bc50b5ab4bc8426110a46d02d7c1b7c74ec Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Tue, 7 Feb 2023 10:53:15 +0000 Subject: [PATCH] chore(docs): incorrect crefs --- .../Internal/LoggerProvider.cs | 4 +- .../LoggerConfiguration.cs | 4 +- .../LoggerExtensions.cs | 84 +++++++++---------- .../Serializer/JsonNamingPolicyDecorator.cs | 6 +- 4 files changed, 51 insertions(+), 47 deletions(-) diff --git a/libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggerProvider.cs b/libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggerProvider.cs index 2b6d7af68..5b18ff974 100644 --- a/libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggerProvider.cs +++ b/libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggerProvider.cs @@ -22,9 +22,9 @@ namespace AWS.Lambda.Powertools.Logging.Internal; /// /// Class LoggerProvider. This class cannot be inherited. -/// Implements the +/// Implements the /// -/// +/// public sealed class LoggerProvider : ILoggerProvider { /// diff --git a/libraries/src/AWS.Lambda.Powertools.Logging/LoggerConfiguration.cs b/libraries/src/AWS.Lambda.Powertools.Logging/LoggerConfiguration.cs index 424e7ca41..4d8ec0c86 100644 --- a/libraries/src/AWS.Lambda.Powertools.Logging/LoggerConfiguration.cs +++ b/libraries/src/AWS.Lambda.Powertools.Logging/LoggerConfiguration.cs @@ -21,9 +21,9 @@ namespace AWS.Lambda.Powertools.Logging; /// /// Class LoggerConfiguration. /// Implements the -/// +/// /// -/// +/// public class LoggerConfiguration : IOptions { /// diff --git a/libraries/src/AWS.Lambda.Powertools.Logging/LoggerExtensions.cs b/libraries/src/AWS.Lambda.Powertools.Logging/LoggerExtensions.cs index e24326f53..8c8dd3110 100644 --- a/libraries/src/AWS.Lambda.Powertools.Logging/LoggerExtensions.cs +++ b/libraries/src/AWS.Lambda.Powertools.Logging/LoggerExtensions.cs @@ -29,7 +29,7 @@ public static class LoggerExtensions /// /// Formats and writes a trace log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogTrace(new {User = user, Address = address}) public static void LogTrace(this ILogger logger, object message) @@ -40,7 +40,7 @@ public static void LogTrace(this ILogger logger, object message) /// /// Formats and writes an trace log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogTrace(exception) public static void LogTrace(this ILogger logger, Exception exception) @@ -51,7 +51,7 @@ public static void LogTrace(this ILogger logger, Exception exception) /// /// Formats and writes a debug log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogDebug(new {User = user, Address = address}) public static void LogDebug(this ILogger logger, object message) @@ -62,7 +62,7 @@ public static void LogDebug(this ILogger logger, object message) /// /// Formats and writes an debug log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogDebug(exception) public static void LogDebug(this ILogger logger, Exception exception) @@ -73,7 +73,7 @@ public static void LogDebug(this ILogger logger, Exception exception) /// /// Formats and writes an information log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogInformation(new {User = user, Address = address}) public static void LogInformation(this ILogger logger, object message) @@ -84,7 +84,7 @@ public static void LogInformation(this ILogger logger, object message) /// /// Formats and writes an information log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogInformation(exception) public static void LogInformation(this ILogger logger, Exception exception) @@ -95,7 +95,7 @@ public static void LogInformation(this ILogger logger, Exception exception) /// /// Formats and writes a warning log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogWarning(new {User = user, Address = address}) public static void LogWarning(this ILogger logger, object message) @@ -106,7 +106,7 @@ public static void LogWarning(this ILogger logger, object message) /// /// Formats and writes an warning log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogWarning(exception) public static void LogWarning(this ILogger logger, Exception exception) @@ -117,7 +117,7 @@ public static void LogWarning(this ILogger logger, Exception exception) /// /// Formats and writes a error log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogCritical(new {User = user, Address = address}) public static void LogError(this ILogger logger, object message) @@ -128,7 +128,7 @@ public static void LogError(this ILogger logger, object message) /// /// Formats and writes an error log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogError(exception) public static void LogError(this ILogger logger, Exception exception) @@ -139,7 +139,7 @@ public static void LogError(this ILogger logger, Exception exception) /// /// Formats and writes a critical log message as JSON. /// - /// The to write to. + /// The to write to. /// The object to be serialized as JSON. /// logger.LogCritical(new {User = user, Address = address}) public static void LogCritical(this ILogger logger, object message) @@ -150,7 +150,7 @@ public static void LogCritical(this ILogger logger, object message) /// /// Formats and writes an critical log message. /// - /// The to write to. + /// The to write to. /// The exception to log. /// logger.LogCritical(exception) public static void LogCritical(this ILogger logger, Exception exception) @@ -161,7 +161,7 @@ public static void LogCritical(this ILogger logger, Exception exception) /// /// Formats and writes a log message as JSON at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// The object to be serialized as JSON. /// logger.Log(LogLevel.Information, new {User = user, Address = address}) @@ -173,7 +173,7 @@ public static void Log(this ILogger logger, LogLevel logLevel, object message) /// /// Formats and writes a log message at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// The exception to log. /// logger.Log(LogLevel.Information, exception) @@ -191,7 +191,7 @@ public static void Log(this ILogger logger, LogLevel logLevel, Exception excepti /// /// Formats and writes a debug log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -207,7 +207,7 @@ public static void LogDebug(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes a debug log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -222,7 +222,7 @@ public static void LogDebug(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes a debug log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -237,7 +237,7 @@ public static void LogDebug(this ILogger logger, T extraKeys, Exception excep /// /// Formats and writes a debug log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -254,7 +254,7 @@ public static void LogDebug(this ILogger logger, T extraKeys, string message, /// /// Formats and writes a trace log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -270,7 +270,7 @@ public static void LogTrace(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes a trace log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -285,7 +285,7 @@ public static void LogTrace(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes a trace log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -300,7 +300,7 @@ public static void LogTrace(this ILogger logger, T extraKeys, Exception excep /// /// Formats and writes a trace log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -317,7 +317,7 @@ public static void LogTrace(this ILogger logger, T extraKeys, string message, /// /// Formats and writes an informational log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -333,7 +333,7 @@ public static void LogInformation(this ILogger logger, T extraKeys, EventId e /// /// Formats and writes an informational log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -348,7 +348,7 @@ public static void LogInformation(this ILogger logger, T extraKeys, EventId e /// /// Formats and writes an informational log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -363,7 +363,7 @@ public static void LogInformation(this ILogger logger, T extraKeys, Exception /// /// Formats and writes an informational log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -380,7 +380,7 @@ public static void LogInformation(this ILogger logger, T extraKeys, string me /// /// Formats and writes a warning log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -396,7 +396,7 @@ public static void LogWarning(this ILogger logger, T extraKeys, EventId event /// /// Formats and writes a warning log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -411,7 +411,7 @@ public static void LogWarning(this ILogger logger, T extraKeys, EventId event /// /// Formats and writes a warning log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -426,7 +426,7 @@ public static void LogWarning(this ILogger logger, T extraKeys, Exception exc /// /// Formats and writes a warning log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -443,7 +443,7 @@ public static void LogWarning(this ILogger logger, T extraKeys, string messag /// /// Formats and writes an error log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -459,7 +459,7 @@ public static void LogError(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes an error log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -474,7 +474,7 @@ public static void LogError(this ILogger logger, T extraKeys, EventId eventId /// /// Formats and writes an error log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -489,7 +489,7 @@ public static void LogError(this ILogger logger, T extraKeys, Exception excep /// /// Formats and writes an error log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -506,7 +506,7 @@ public static void LogError(this ILogger logger, T extraKeys, string message, /// /// Formats and writes a critical log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// The exception to log. @@ -522,7 +522,7 @@ public static void LogCritical(this ILogger logger, T extraKeys, EventId even /// /// Formats and writes a critical log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The event id associated with the log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -537,7 +537,7 @@ public static void LogCritical(this ILogger logger, T extraKeys, EventId even /// /// Formats and writes a critical log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// The exception to log. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" @@ -552,7 +552,7 @@ public static void LogCritical(this ILogger logger, T extraKeys, Exception ex /// /// Formats and writes a critical log message. /// - /// The to write to. + /// The to write to. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" /// An object array that contains zero or more objects to format. @@ -569,7 +569,7 @@ public static void LogCritical(this ILogger logger, T extraKeys, string messa /// /// Formats and writes a log message at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// Additional keys will be appended to the log entry. /// The event id associated with the log. @@ -592,7 +592,7 @@ public static void Log(this ILogger logger, LogLevel logLevel, T extraKeys, E /// /// Formats and writes a log message at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// Additional keys will be appended to the log entry. /// The event id associated with the log. @@ -608,7 +608,7 @@ public static void Log(this ILogger logger, LogLevel logLevel, T extraKeys, E /// /// Formats and writes a log message at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// Additional keys will be appended to the log entry. /// The exception to log. @@ -624,7 +624,7 @@ public static void Log(this ILogger logger, LogLevel logLevel, T extraKeys, E /// /// Formats and writes a log message at the specified log level. /// - /// The to write to. + /// The to write to. /// Entry will be written on this level. /// Additional keys will be appended to the log entry. /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" diff --git a/libraries/src/AWS.Lambda.Powertools.Metrics/Serializer/JsonNamingPolicyDecorator.cs b/libraries/src/AWS.Lambda.Powertools.Metrics/Serializer/JsonNamingPolicyDecorator.cs index f694d5846..162df36cc 100644 --- a/libraries/src/AWS.Lambda.Powertools.Metrics/Serializer/JsonNamingPolicyDecorator.cs +++ b/libraries/src/AWS.Lambda.Powertools.Metrics/Serializer/JsonNamingPolicyDecorator.cs @@ -19,7 +19,11 @@ protected JsonNamingPolicyDecorator(JsonNamingPolicy underlyingNamingPolicy) _underlyingNamingPolicy = underlyingNamingPolicy; } - /// + /// + /// When overridden in a derived class, converts the specified name according to the policy. + /// + /// The name to convert. + /// The converted name. public override string ConvertName(string name) { return _underlyingNamingPolicy == null ? name : _underlyingNamingPolicy.ConvertName(name);