Skip to content

Commit b56f932

Browse files
carlossanlopmaryamariyan
carlossanlop
and
maryamariyan
authored
Automatic port of Microsoft.Extensions.Logging docs (dotnet#4931)
* Automatic port of Microsoft.Extensions.Logging docs * Apply suggestions from code review Co-authored-by: Maryam Ariyan <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Maryam Ariyan <[email protected]>
1 parent 0a7f84c commit b56f932

File tree

7 files changed

+93
-93
lines changed

7 files changed

+93
-93
lines changed

‎xml/Microsoft.Extensions.Logging.Abstractions/LogEntry`1.xml‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<Interfaces />
1919
<Docs>
2020
<typeparam name="TState">To be added.</typeparam>
21-
<summary>To be added.</summary>
21+
<summary>Holds the information for a single log entry.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -43,13 +43,13 @@
4343
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
4444
</Parameters>
4545
<Docs>
46-
<param name="logLevel">To be added.</param>
47-
<param name="category">To be added.</param>
48-
<param name="eventId">To be added.</param>
49-
<param name="state">To be added.</param>
50-
<param name="exception">To be added.</param>
51-
<param name="formatter">To be added.</param>
52-
<summary>To be added.</summary>
46+
<param name="logLevel">The log level.</param>
47+
<param name="category">The category name for the log.</param>
48+
<param name="eventId">The log event Id.</param>
49+
<param name="state">The state for which log is being written.</param>
50+
<param name="exception">The log exception.</param>
51+
<param name="formatter">The formatter.</param>
52+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.Abstractions.LogEntry`1" /> using the specified log level, category, event Id, state, exception and formatter parameters.</summary>
5353
<remarks>To be added.</remarks>
5454
</Docs>
5555
</Member>
@@ -69,8 +69,8 @@
6969
<ReturnType>System.String</ReturnType>
7070
</ReturnValue>
7171
<Docs>
72-
<summary>To be added.</summary>
73-
<value>To be added.</value>
72+
<summary>Gets the log category.</summary>
73+
<value>A string that represents the log category.</value>
7474
<remarks>To be added.</remarks>
7575
</Docs>
7676
</Member>
@@ -90,8 +90,8 @@
9090
<ReturnType>Microsoft.Extensions.Logging.EventId</ReturnType>
9191
</ReturnValue>
9292
<Docs>
93-
<summary>To be added.</summary>
94-
<value>To be added.</value>
93+
<summary>Gets the log event Id.</summary>
94+
<value>An <see cref="T:Microsoft.Extensions.Logging.EventId" /> instance.</value>
9595
<remarks>To be added.</remarks>
9696
</Docs>
9797
</Member>
@@ -111,8 +111,8 @@
111111
<ReturnType>System.Exception</ReturnType>
112112
</ReturnValue>
113113
<Docs>
114-
<summary>To be added.</summary>
115-
<value>To be added.</value>
114+
<summary>Gets the log exception.</summary>
115+
<value>An <see cref="T:System.Exception" /> instance.</value>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>
@@ -132,8 +132,8 @@
132132
<ReturnType>System.Func&lt;TState,System.Exception,System.String&gt;</ReturnType>
133133
</ReturnValue>
134134
<Docs>
135-
<summary>To be added.</summary>
136-
<value>To be added.</value>
135+
<summary>Gets the formatter.</summary>
136+
<value>The encapsulated method that represents a formatter, which takes a <typeparamref name="TState" /> and a <see cref="T:System.Exception" />, and returns a string.</value>
137137
<remarks>To be added.</remarks>
138138
</Docs>
139139
</Member>
@@ -153,8 +153,8 @@
153153
<ReturnType>Microsoft.Extensions.Logging.LogLevel</ReturnType>
154154
</ReturnValue>
155155
<Docs>
156-
<summary>To be added.</summary>
157-
<value>To be added.</value>
156+
<summary>Gets the log level.</summary>
157+
<value>A <see cref="T:Microsoft.Extensions.Logging.LogLevel" /> instance.</value>
158158
<remarks>To be added.</remarks>
159159
</Docs>
160160
</Member>
@@ -174,8 +174,8 @@
174174
<ReturnType>TState</ReturnType>
175175
</ReturnValue>
176176
<Docs>
177-
<summary>To be added.</summary>
178-
<value>To be added.</value>
177+
<summary>Gets the <typeparamref name="TState" />.</summary>
178+
<value>An object of type <typeparamref name="TState" />.</value>
179179
<remarks>To be added.</remarks>
180180
</Docs>
181181
</Member>

‎xml/Microsoft.Extensions.Logging/ActivityTrackingOptions.xml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
22+
<summary>Defines the flags to indicate which trace context parts should be included with the logging scopes.</summary>
2323
<remarks>To be added.</remarks>
2424
</Docs>
2525
<Members>
@@ -40,7 +40,7 @@
4040
</ReturnValue>
4141
<MemberValue>0</MemberValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>None of the trace context part will be included in the logging.</summary>
4444
</Docs>
4545
</Member>
4646
<Member MemberName="ParentId">
@@ -60,7 +60,7 @@
6060
</ReturnValue>
6161
<MemberValue>4</MemberValue>
6262
<Docs>
63-
<summary>To be added.</summary>
63+
<summary>Parent Id will be included in the logging.</summary>
6464
</Docs>
6565
</Member>
6666
<Member MemberName="SpanId">
@@ -80,7 +80,7 @@
8080
</ReturnValue>
8181
<MemberValue>1</MemberValue>
8282
<Docs>
83-
<summary>To be added.</summary>
83+
<summary>Span Id will be included in the logging.</summary>
8484
</Docs>
8585
</Member>
8686
<Member MemberName="TraceFlags">
@@ -100,7 +100,7 @@
100100
</ReturnValue>
101101
<MemberValue>16</MemberValue>
102102
<Docs>
103-
<summary>To be added.</summary>
103+
<summary>Trace flags will be included in the logging.</summary>
104104
</Docs>
105105
</Member>
106106
<Member MemberName="TraceId">
@@ -120,7 +120,7 @@
120120
</ReturnValue>
121121
<MemberValue>2</MemberValue>
122122
<Docs>
123-
<summary>To be added.</summary>
123+
<summary>Trace Id will be included in the logging.</summary>
124124
</Docs>
125125
</Member>
126126
<Member MemberName="TraceState">
@@ -140,7 +140,7 @@
140140
</ReturnValue>
141141
<MemberValue>8</MemberValue>
142142
<Docs>
143-
<summary>To be added.</summary>
143+
<summary>Trace State will be included in the logging.</summary>
144144
</Docs>
145145
</Member>
146146
</Members>

‎xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -419,11 +419,11 @@
419419
<Parameter Name="builder" Type="Microsoft.Extensions.Logging.ILoggingBuilder" RefType="this" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" />
420420
</Parameters>
421421
<Docs>
422-
<typeparam name="TFormatter">To be added.</typeparam>
423-
<typeparam name="TOptions">To be added.</typeparam>
424-
<param name="builder">To be added.</param>
425-
<summary>To be added.</summary>
426-
<returns>To be added.</returns>
422+
<typeparam name="TFormatter">The custom console logger formatter.</typeparam>
423+
<typeparam name="TOptions">The configuration options.</typeparam>
424+
<param name="builder">The current logging builder instance to use.</param>
425+
<summary>Adds a custom console logger formatter.</summary>
426+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
427427
<remarks>To be added.</remarks>
428428
</Docs>
429429
</Member>
@@ -459,12 +459,12 @@
459459
<Parameter Name="configure" Type="System.Action&lt;TOptions&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
460460
</Parameters>
461461
<Docs>
462-
<typeparam name="TFormatter">To be added.</typeparam>
463-
<typeparam name="TOptions">To be added.</typeparam>
464-
<param name="builder">To be added.</param>
465-
<param name="configure">To be added.</param>
466-
<summary>To be added.</summary>
467-
<returns>To be added.</returns>
462+
<typeparam name="TFormatter">The custom console logger formatter.</typeparam>
463+
<typeparam name="TOptions">The configuration options.</typeparam>
464+
<param name="builder">The current logging builder instance to use.</param>
465+
<param name="configure">A delegate to configure <paramref name="TOptions" /> for the custom formatter <paramref name="TFormatter" />.</param>
466+
<summary>Adds a custom console logger formatter to be configured with the specified options.</summary>
467+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
468468
<remarks>To be added.</remarks>
469469
</Docs>
470470
</Member>
@@ -487,9 +487,9 @@
487487
<Parameter Name="builder" Type="Microsoft.Extensions.Logging.ILoggingBuilder" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
488488
</Parameters>
489489
<Docs>
490-
<param name="builder">To be added.</param>
491-
<summary>To be added.</summary>
492-
<returns>To be added.</returns>
490+
<param name="builder">The current logging builder instance to use.</param>
491+
<summary>Adds a console log formatter named 'json' to the factory with default properties.</summary>
492+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
493493
<remarks>To be added.</remarks>
494494
</Docs>
495495
</Member>
@@ -513,10 +513,10 @@
513513
<Parameter Name="configure" Type="System.Action&lt;Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
514514
</Parameters>
515515
<Docs>
516-
<param name="builder">To be added.</param>
517-
<param name="configure">To be added.</param>
518-
<summary>To be added.</summary>
519-
<returns>To be added.</returns>
516+
<param name="builder">The current logging builder instance to use.</param>
517+
<param name="configure">A delegate to configure the console logger options for the built-in json log formatter.</param>
518+
<summary>Adds a console log formatter named 'json' to the factory configured with the specified Json console formatter options.</summary>
519+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
520520
<remarks>To be added.</remarks>
521521
</Docs>
522522
</Member>
@@ -539,9 +539,9 @@
539539
<Parameter Name="builder" Type="Microsoft.Extensions.Logging.ILoggingBuilder" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
540540
</Parameters>
541541
<Docs>
542-
<param name="builder">To be added.</param>
543-
<summary>To be added.</summary>
544-
<returns>To be added.</returns>
542+
<param name="builder">The current logging builder instance to use.</param>
543+
<summary>Adds the default console log formatter named 'simple' to the factory with default properties.</summary>
544+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
545545
<remarks>To be added.</remarks>
546546
</Docs>
547547
</Member>
@@ -565,10 +565,10 @@
565565
<Parameter Name="configure" Type="System.Action&lt;Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
566566
</Parameters>
567567
<Docs>
568-
<param name="builder">To be added.</param>
569-
<param name="configure">To be added.</param>
570-
<summary>To be added.</summary>
571-
<returns>To be added.</returns>
568+
<param name="builder">The current logging builder instance to use.</param>
569+
<param name="configure">A delegate to configure the console logger options for the built-in default log formatter.</param>
570+
<summary>Adds a console log formatter named 'simple' to the factory configured with the specified simple console formatter options.</summary>
571+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
572572
<remarks>To be added.</remarks>
573573
</Docs>
574574
</Member>
@@ -591,9 +591,9 @@
591591
<Parameter Name="builder" Type="Microsoft.Extensions.Logging.ILoggingBuilder" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
592592
</Parameters>
593593
<Docs>
594-
<param name="builder">To be added.</param>
595-
<summary>To be added.</summary>
596-
<returns>To be added.</returns>
594+
<param name="builder">The current logging builder instance to use.</param>
595+
<summary>Adds a console log formatter named 'systemd' to the factory with default properties.</summary>
596+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
597597
<remarks>To be added.</remarks>
598598
</Docs>
599599
</Member>
@@ -617,10 +617,10 @@
617617
<Parameter Name="configure" Type="System.Action&lt;Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
618618
</Parameters>
619619
<Docs>
620-
<param name="builder">To be added.</param>
621-
<param name="configure">To be added.</param>
622-
<summary>To be added.</summary>
623-
<returns>To be added.</returns>
620+
<param name="builder">The current logging builder instance to use.</param>
621+
<param name="configure">A delegate to configure the console logger options for the built-in systemd log formatter.</param>
622+
<summary>Adds a console log formatter named 'systemd' to the factory configured with the specified console formatter options.</summary>
623+
<returns>The current logging builder instance so that additional calls can be chained.</returns>
624624
<remarks>To be added.</remarks>
625625
</Docs>
626626
</Member>

‎xml/Microsoft.Extensions.Logging/LoggerFactory.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,10 @@
155155
<Parameter Name="options" Type="Microsoft.Extensions.Options.IOptions&lt;Microsoft.Extensions.Logging.LoggerFactoryOptions&gt;" Index="2" FrameworkAlternate="dotnet-plat-ext-5.0" />
156156
</Parameters>
157157
<Docs>
158-
<param name="providers">To be added.</param>
159-
<param name="filterOption">To be added.</param>
160-
<param name="options">To be added.</param>
161-
<summary>To be added.</summary>
158+
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
159+
<param name="filterOption">The filter option to use.</param>
160+
<param name="options">The logger factory options.</param>
161+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers, filter option and logger factory options.</summary>
162162
<remarks>To be added.</remarks>
163163
</Docs>
164164
</Member>

‎xml/Microsoft.Extensions.Logging/LoggerFactoryOptions.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Defines the options for a logger factory.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions" /> instance.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>
@@ -51,8 +51,8 @@
5151
<ReturnType>Microsoft.Extensions.Logging.ActivityTrackingOptions</ReturnType>
5252
</ReturnValue>
5353
<Docs>
54-
<summary>To be added.</summary>
55-
<value>To be added.</value>
54+
<summary>Gets or sets the activity tracking options to indicate which parts of the tracing context information should be included with the logging scopes.</summary>
55+
<value>An activity tracking options instance.</value>
5656
<remarks>To be added.</remarks>
5757
</Docs>
5858
</Member>

‎xml/Microsoft.Extensions.Logging/LoggerMessage.xml‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -502,13 +502,13 @@
502502
<Parameter Name="formatString" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" />
503503
</Parameters>
504504
<Docs>
505-
<typeparam name="T1">To be added.</typeparam>
506-
<typeparam name="T2">To be added.</typeparam>
507-
<typeparam name="T3">To be added.</typeparam>
508-
<typeparam name="T4">To be added.</typeparam>
509-
<param name="formatString">To be added.</param>
510-
<summary>To be added.</summary>
511-
<returns>To be added.</returns>
505+
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
506+
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
507+
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
508+
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
509+
<param name="formatString">The named format string.</param>
510+
<summary>Creates a delegate which can be invoked to create a log scope.</summary>
511+
<returns>A delegate which when invoked creates a log scope.</returns>
512512
<remarks>To be added.</remarks>
513513
</Docs>
514514
</Member>
@@ -538,14 +538,14 @@
538538
<Parameter Name="formatString" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" />
539539
</Parameters>
540540
<Docs>
541-
<typeparam name="T1">To be added.</typeparam>
542-
<typeparam name="T2">To be added.</typeparam>
543-
<typeparam name="T3">To be added.</typeparam>
544-
<typeparam name="T4">To be added.</typeparam>
545-
<typeparam name="T5">To be added.</typeparam>
546-
<param name="formatString">To be added.</param>
547-
<summary>To be added.</summary>
548-
<returns>To be added.</returns>
541+
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
542+
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
543+
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
544+
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
545+
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
546+
<param name="formatString">The named format string.</param>
547+
<summary>Creates a delegate which can be invoked to create a log scope.</summary>
548+
<returns>A delegate which when invoked creates a log scope.</returns>
549549
<remarks>To be added.</remarks>
550550
</Docs>
551551
</Member>
@@ -576,15 +576,15 @@
576576
<Parameter Name="formatString" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" />
577577
</Parameters>
578578
<Docs>
579-
<typeparam name="T1">To be added.</typeparam>
580-
<typeparam name="T2">To be added.</typeparam>
581-
<typeparam name="T3">To be added.</typeparam>
582-
<typeparam name="T4">To be added.</typeparam>
583-
<typeparam name="T5">To be added.</typeparam>
584-
<typeparam name="T6">To be added.</typeparam>
585-
<param name="formatString">To be added.</param>
586-
<summary>To be added.</summary>
587-
<returns>To be added.</returns>
579+
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
580+
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
581+
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
582+
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
583+
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
584+
<typeparam name="T6">The type of the sisxth parameter passed to the named format string.</typeparam>
585+
<param name="formatString">The named format string.</param>
586+
<summary>Creates a delegate which can be invoked to create a log scope.</summary>
587+
<returns>A delegate which when invoked creates a log scope.</returns>
588588
<remarks>To be added.</remarks>
589589
</Docs>
590590
</Member>

0 commit comments

Comments
 (0)