Added class documentation to sample webapi logging classes

#14

Author: Caldas

src/SampleWebAPI/Logging/LoggerFactoryExtensions.cs

@@ -5,26 +5,53 @@
 
 namespace VTEX.SampleWebAPI
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public static class LoggerFactoryExtensions
     {
+        /// <summary>
+        /// Add <see cref="T:Splunk.Providers.SplunkHECRawLoggerProvider"/> as provider to logger factory.
+        /// </summary>
+        /// <param name="loggerFactory">Logger factory.</param>
+        /// <param name="configuration">Configuration.</param>
+        /// <param name="formatter">Custom text formatter.</param>
         public static ILoggerFactory AddHECRawSplunkLogger(this ILoggerFactory loggerFactory, SplunkLoggerConfiguration configuration, ILoggerFormatter formatter)
         {
             loggerFactory.AddProvider(new SplunkHECRawLoggerProvider(configuration, formatter));
             return loggerFactory;
         }
 
+        /// <summary>
+        /// Add <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> as provider to logger factory.
+        /// </summary>
+        /// <param name="loggerFactory">Logger factory.</param>
+        /// <param name="configuration">Configuration.</param>
+        /// <param name="formatter">Custom text formatter.</param>
         public static ILoggerFactory AddHECJsonSplunkLogger(this ILoggerFactory loggerFactory, SplunkLoggerConfiguration configuration, ILoggerFormatter formatter)
         {
             loggerFactory.AddProvider(new SplunkHECJsonLoggerProvider(configuration, formatter));
             return loggerFactory;
         }
 
+        /// <summary>
+        /// Add <see cref="T:Splunk.Providers.SplunkTcpLoggerProvider"/> as provider to logger factory.
+        /// </summary>
+        /// <param name="loggerFactory">Logger factory.</param>
+        /// <param name="configuration">Configuration.</param>
+        /// <param name="formatter">Custom text formatter.</param>
         public static ILoggerFactory AddTcpSplunkLogger(this ILoggerFactory loggerFactory, SplunkLoggerConfiguration configuration, ILoggerFormatter formatter)
         {
             loggerFactory.AddProvider(new SplunkTcpLoggerProvider(configuration, formatter));
             return loggerFactory;
         }
 
+        /// <summary>
+        /// Add <see cref="T:Splunk.Providers.SplunkUdpLoggerProvider"/> as provider to logger factory.
+        /// </summary>
+        /// <param name="loggerFactory">Logger factory.</param>
+        /// <param name="configuration">Configuration.</param>
+        /// <param name="formatter">Custom text formatter.</param>
         public static ILoggerFactory AddUdpSplunkLogger(this ILoggerFactory loggerFactory, SplunkLoggerConfiguration configuration, ILoggerFormatter formatter)
         {
             loggerFactory.AddProvider(new SplunkUdpLoggerProvider(configuration, formatter));

src/SampleWebAPI/Logging/VTEXEventLevel.cs

@@ -1,6 +1,9 @@
 
 namespace VTEX.SampleWebAPI.Logging
 {
+    /// <summary>
+    /// This enumeration represents the log event levels defined at VTEX.
+    /// </summary>
     public enum VTEXEventLevel : int
     {
         Critical = 3,

src/SampleWebAPI/Logging/VTEXLogType.cs

@@ -1,6 +1,9 @@
 
 namespace VTEX.SampleWebAPI.Logging
 {
+    /// <summary>
+    /// This enumeration represents the log types defined at VTEX.
+    /// </summary>
     public enum VTEXLogType
     {
         Error,

src/SampleWebAPI/Logging/VTEXSplunkEntry.cs

@@ -3,14 +3,44 @@
 
 namespace VTEX.SampleWebAPI.Logging
 {
+    /// <summary>
+    /// This class represents a VTEX log entry.
+    /// </summary>
     public class VTEXSplunkEntry
     {
+        /// <summary>
+        /// Workflow type is a VTEX concept almost similar as `{EventId.Name}` concept.
+        /// </summary>
         public string WorkflowType { get; private set; }
+
+        /// <summary>
+        /// Workflow instace is a VTEX concept almost similar as `{EventId.Id}` concept.
+        /// </summary>
         public string WorkflowInstance { get; private set; }
+
+        /// <summary>
+        /// For which account this log happened.
+        /// </summary>
         public string Account { get; private set; }
+
+        /// <summary>
+        /// Exception to be logged.
+        /// </summary>
         public Exception Exception { get; private set; }
+
+        /// <summary>
+        /// Extra parameters that will be represented as `{Key}="{Value}"` entries at Splunk text message.
+        /// </summary>
         public List<Tuple<string, string>> ExtraParameters { get; private set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="T:VTEX.SampleWebAPI.Logging.VTEXSplunkEntry"/> class.
+        /// </summary>
+        /// <param name="workflowType">Workflow type.</param>
+        /// <param name="workflowInstance">Workflow instance.</param>
+        /// <param name="account">Account.</param>
+        /// <param name="exception">Exception.</param>
+        /// <param name="extraParameters">Extra parameters.</param>
         public VTEXSplunkEntry(string workflowType, string workflowInstance, string account = "", Exception exception = null, params Tuple<string, string>[] extraParameters)
         {
             if (string.IsNullOrWhiteSpace(workflowType))

src/SampleWebAPI/Logging/VTEXSplunkEntryExtensions.cs

@@ -4,10 +4,23 @@
 
 namespace VTEX.SampleWebAPI
 {
+    /// <summary>
+    /// This class contains ILogger extension method to simplify the process to record a VTEX log.
+    /// </summary>
     public static class VTEXSplunkEntryExtensions
     {
         static readonly EventId EmptyEventId = new EventId();
 
+        /// <summary>
+        /// Log to Splunk.
+        /// </summary>
+        /// <param name="logger">Logger.</param>
+        /// <param name="logLevel">Log level.</param>
+        /// <param name="workflowType">Workflow type.</param>
+        /// <param name="workflowInstance">Workflow instance.</param>
+        /// <param name="account">Account.</param>
+        /// <param name="exception">Exception.</param>
+        /// <param name="extraParameters">Extra parameters.</param>
         public static void DefineVTEXLog(this ILogger logger, LogLevel logLevel, string workflowType, string workflowInstance, string account = "", Exception exception = null, params Tuple<string, string>[] extraParameters)
         {
             string formattedMessage = string.Empty;
@@ -29,4 +42,4 @@ public static void DefineVTEXLog(this ILogger logger, LogLevel logLevel, string
                         });
         }
     }
-}
+}