Merge pull request #95 from rafaelsc/feature/improveDocumentation

Improve XML documentation
serilog · Jul 24, 2020 · 65e237f · 65e237f
2 parents e992708 + 65ce4a1
commit 65e237f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/src/Serilog.Sinks.Console/ConsoleLoggerConfigurationExtensions.cs b/src/Serilog.Sinks.Console/ConsoleLoggerConfigurationExtensions.cs
@@ -50,6 +50,8 @@ public static class ConsoleLoggerConfigurationExtensions
         /// uses <see cref="SystemConsoleTheme.Literate"/>.</param>
         /// <param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
         /// <returns>Configuration object allowing method chaining.</returns>
+        /// <exception cref="ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
+        /// <exception cref="ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
         public static LoggerConfiguration Console(
             this LoggerSinkConfiguration sinkConfiguration,
             LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
@@ -89,6 +91,8 @@ public static class ConsoleLoggerConfigurationExtensions
         /// to be changed at runtime.</param>
         /// <param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
         /// <returns>Configuration object allowing method chaining.</returns>
+        /// <exception cref="ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
+        /// <exception cref="ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
         public static LoggerConfiguration Console(
             this LoggerSinkConfiguration sinkConfiguration,
             ITextFormatter formatter,

diff --git a/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/AnsiConsoleTheme.cs b/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/AnsiConsoleTheme.cs
@@ -47,6 +47,7 @@ public class AnsiConsoleTheme : ConsoleTheme
         /// Construct a theme given a set of styles.
         /// </summary>
         /// <param name="styles">Styles to apply within the theme.</param>
+        /// <exception cref="ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
         public AnsiConsoleTheme(IReadOnlyDictionary<ConsoleThemeStyle, string> styles)
         {
             if (styles is null) throw new ArgumentNullException(nameof(styles));

diff --git a/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/SystemConsoleTheme.cs b/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/SystemConsoleTheme.cs
@@ -44,6 +44,7 @@ public class SystemConsoleTheme : ConsoleTheme
         /// Construct a theme given a set of styles.
         /// </summary>
         /// <param name="styles">Styles to apply within the theme.</param>
+        /// <exception cref="ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
         public SystemConsoleTheme(IReadOnlyDictionary<ConsoleThemeStyle, SystemConsoleThemeStyle> styles)
         {
             if (styles is null) throw new ArgumentNullException(nameof(styles));