Add docs for new console logging APIs

dotnet · Sep 30, 2020 · c26a06f · c26a06f
1 parent 3f84498
commit c26a06f
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 25 deletions.
diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml
@@ -14,7 +14,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Allows custom log message formatting.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -55,7 +55,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets the name associated with the console log formatter.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -91,12 +91,12 @@
         <Parameter Name="textWriter" Type="System.IO.TextWriter" />
       </Parameters>
       <Docs>
-        <typeparam name="TState">To be added.</typeparam>
-        <param name="logEntry">To be added.</param>
-        <param name="scopeProvider">To be added.</param>
-        <param name="textWriter">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <typeparam name="TState">The type of the object to be written.</typeparam>
+        <param name="logEntry">The log entry.</param>
+        <param name="scopeProvider">The provider of scope data.</param>
+        <param name="textWriter">The string writer embedding ansi code for colors.</param>
+        <summary>Writes the log message to the specified TextWriter.</summary>
+        <remarks>if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml
@@ -14,7 +14,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Reserved formatter names for the built-in console formatters.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -34,7 +34,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Reserved name for json console formatter.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -54,7 +54,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Reserved name for simple console formatter.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -74,7 +74,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Reserved name for systemd console formatter</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterOptions.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterOptions.xml
@@ -14,7 +14,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Options for the built-in console log formatter.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -51,7 +51,7 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Includes scopes when <see langword="true" />.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -72,7 +72,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -93,7 +93,7 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/xml/Microsoft.Extensions.Logging.Console/JsonConsoleFormatterOptions.xml b/xml/Microsoft.Extensions.Logging.Console/JsonConsoleFormatterOptions.xml
@@ -14,7 +14,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Options for the built-in json console log formatter.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -51,7 +51,7 @@
         <ReturnType>System.Text.Json.JsonWriterOptions</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets or sets JsonWriterOptions.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml b/xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml
@@ -13,7 +13,7 @@
     <BaseTypeName>System.Enum</BaseTypeName>
   </Base>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Determines when to use color when logging messages.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -34,7 +34,8 @@
       </ReturnValue>
       <MemberValue>0</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Use the default color behavior, enabling color except when the console output is redirected.</summary>
+        <remarks>Enables color except when the console output is redirected.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Disabled">
@@ -54,7 +55,7 @@
       </ReturnValue>
       <MemberValue>2</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Disable color for logging.</summary>
       </Docs>
     </Member>
     <Member MemberName="Enabled">
@@ -74,7 +75,7 @@
       </ReturnValue>
       <MemberValue>1</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Enable color for logging.</summary>
       </Docs>
     </Member>
   </Members>

diff --git a/xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml b/xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml
@@ -14,7 +14,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Options for the built-in default console log formatter.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -51,7 +51,7 @@
         <ReturnType>Microsoft.Extensions.Logging.Console.LoggerColorBehavior</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Determines when to use color when logging messages.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -72,7 +72,7 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>