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

Add docs for new console logging APIs #4918

Closed
wants to merge 1 commit into from
Closed

Add docs for new console logging APIs #4918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 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,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>
Expand Down Expand Up @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Writes the log message to the specified TextWriter.</summary>
<summary>Writes the log message to the specified text writer.</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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<remarks>if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string.</remarks>
<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>
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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Reserved formatter names for the built-in console formatters.</summary>
<summary>Provides 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Reserved name for json console formatter.</summary>
<summary>The name reserved for the 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Reserved name for systemd console formatter</summary>
<summary>Reserved name for the systemd console formatter.</summary>

<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Options for the built-in console log formatter.</summary>
<summary>Specifies options for the built-in console log formatter.</summary>

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,7 +51,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Includes scopes when <see langword="true" />.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Includes scopes when <see langword="true" />.</summary>
<summary>Gets or sets a value that indicates whether scopes should be included.</summary>

<value>To be added.</value>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>To be added.</value>
<value><see langword="true" /> if scopes are included; otherwise, <see langword="false" />.</value>

<remarks>To be added.</remarks>
</Docs>
Expand All @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.</summary>
<summary>Gets or sets the format string used to format timestamps in logging messages.</summary>

<value>To be added.</value>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>To be added.</value>
<value>The format string used to format timestamps in logging messages. The default is <see langword="null" />.</value>

<remarks>To be added.</remarks>
</Docs>
Expand All @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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>
<summary>Gets or sets a value that indicates whether the UTC time zone is used to for timestamps in logging messages.</summary>

<value>To be added.</value>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>To be added.</value>
<value><see langword="true" /> if the UTC time zone is used for timestamps in logging messages; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>

<remarks>To be added.</remarks>
</Docs>
Expand Down
4 changes: 2 additions & 2 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Options for the built-in json console log formatter.</summary>
<summary>Specifies options for the built-in JSON console log formatter.</summary>

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,7 +51,7 @@
<ReturnType>System.Text.Json.JsonWriterOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets JsonWriterOptions.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Gets or sets JsonWriterOptions.</summary>
<summary>Gets or sets options for the JSON writer.</summary>

<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
9 changes: 5 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Determines when to use color when logging messages.</summary>
<summary>Specifies constants that define when to use color in log messages.</summary>

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Use the default color behavior, enabling color except when the console output is redirected.</summary>
<summary>The default color behavior, which is to enable 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">
Expand All @@ -54,7 +55,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Disable color for logging.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Disable color for logging.</summary>
<summary>Don't use color for logging.</summary>

</Docs>
</Member>
<Member MemberName="Enabled">
Expand All @@ -74,7 +75,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Enable color for logging.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Enable color for logging.</summary>
<summary>Use color for logging.</summary>

</Docs>
</Member>
</Members>
Expand Down
6 changes: 3 additions & 3 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Options for the built-in default console log formatter.</summary>
<summary>Specifies options for the built-in, default console log formatter.</summary>

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>Determines when to use color when logging messages.</summary>
<summary>Gets or sets a value that indicates when to use color for log messages.</summary>

<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>When <see langword="true" />, the entire message gets logged in a single line.</summary>
<summary>Gets or sets a value that indicates whether the entire message should be logged as a single line.</summary>

<value>To be added.</value>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>To be added.</value>
<value><see langword="true" />to log the entire message as a single line; otherwise, <see langword=false />.</value>

<remarks>To be added.</remarks>
</Docs>
Expand Down