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

Jump to bottom

Automatic port of Microsoft.Extensions.Logging.Console docs #4925

Merged
merged 3 commits into from
Oct 14, 2020
Merged

Automatic port of Microsoft.Extensions.Logging.Console docs #4925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51dd98c
Automatic port of Microsoft.Extensions.Logging.Console docs
carlossanlop Sep 30, 2020
18c7521
Apply suggestions from code review
carlossanlop Oct 1, 2020
4c246f1
Apply suggestions from code review
carlossanlop Oct 14, 2020
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
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleFormatter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -55,8 +55,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the name associated with the console log formatter.</summary>
<value>A string that represents the name associated with the console log formatter.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterNames.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleFormatterOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -51,8 +51,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets whether scopes should be included or not.</summary>
<value><see langword="true" /> when scopes should be included; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -72,8 +72,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets format string used to format timestamp in logging messages. Defaults to <see langword="null" />.</summary>
<value>A string representing the timestamp format.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -93,8 +93,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <see langword="false" />.</summary>
<value><see langword="true" /> to use UTC timezone; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>The name of the log message formatter to use. Defaults to "simple".</summary>
<value>A string that represents the formatter name.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -232,8 +232,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a value that indicates whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <see langword="false" />.</summary>
<value><see langword="true" /> to use UTC timezone; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@
<Parameter Name="formatters" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.Logging.Console.ConsoleFormatter&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
</Parameters>
<Docs>
<param name="options">To be added.</param>
<param name="formatters">To be added.</param>
<summary>To be added.</summary>
<param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" /> instances with.</param>
<param name="formatters">Log formatters added for <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" /> insteaces.</param>
<summary>Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Logging.Console/JsonConsoleFormatterOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -51,8 +51,8 @@
<ReturnType>System.Text.Json.JsonWriterOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a Json writer options instance.</summary>
<value>A <see cref="T:System.Text.Json.JsonWriterOptions" /> instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
17 changes: 13 additions & 4 deletions xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -34,7 +34,16 @@
</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>
<format type="text/markdown"><![CDATA[

## Remarks

Enables color except when the console output is redirected.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Disabled">
Expand All @@ -54,7 +63,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disable color for logging.</summary>
</Docs>
</Member>
<Member MemberName="Enabled">
Expand All @@ -74,7 +83,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Enable color for logging.</summary>
</Docs>
</Member>
</Members>
Expand Down
10 changes: 5 additions & 5 deletions xml/Microsoft.Extensions.Logging.Console/SimpleConsoleFormatterOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -51,8 +51,8 @@
<ReturnType>Microsoft.Extensions.Logging.Console.LoggerColorBehavior</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Determines when to use color when logging messages.</summary>
<value>An object that determines the logger color behavior.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -72,8 +72,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Indicates whether the entire message gets logged in a single line or not.</summary>
<value><see langword="true" /> to log the entire message in a single line; <see langword="false" /> otherwise..</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down