Skip to content

Commit a521571

Browse files
maryamariyanmaryamariyan
authored
Microsoft Extensions Logging docs (#4104)
* Microsoft Extensions Logging docs * Exclude AzureAppServices * Apply PR feedback
1 parent d8e6102 commit a521571

File tree

25 files changed

+165
-140
lines changed

25 files changed

+165
-140
lines changed

‎xml/Microsoft.Extensions.Logging.Abstractions.Internal/NullScope.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NullScope" FullName="Microsoft.Extensions.Logging.Abstractions.Internal.NullScope">
1+
<Type Name="NullScope" FullName="Microsoft.Extensions.Logging.Abstractions.Internal.NullScope">
22
<TypeSignature Language="C#" Value="public class NullScope : IDisposable" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NullScope extends System.Object implements class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Abstractions.Internal.NullScope" />
@@ -48,7 +48,7 @@
4848
</ReturnValue>
4949
<Parameters />
5050
<Docs>
51-
<summary>To be added.</summary>
51+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
5252
<remarks>To be added.</remarks>
5353
<inheritdoc />
5454
</Docs>

‎xml/Microsoft.Extensions.Logging.Abstractions/NullLogger.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NullLogger" FullName="Microsoft.Extensions.Logging.Abstractions.NullLogger">
1+
<Type Name="NullLogger" FullName="Microsoft.Extensions.Logging.Abstractions.NullLogger">
22
<TypeSignature Language="C#" Value="public class NullLogger : Microsoft.Extensions.Logging.ILogger" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NullLogger extends System.Object implements class Microsoft.Extensions.Logging.ILogger" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" />
@@ -59,8 +59,8 @@
5959
<Docs>
6060
<typeparam name="TState">To be added.</typeparam>
6161
<param name="state">To be added.</param>
62-
<summary>To be added.</summary>
63-
<returns>To be added.</returns>
62+
<summary>Begins a logical operation scope.</summary>
63+
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
6464
<remarks>To be added.</remarks>
6565
<inheritdoc />
6666
</Docs>
@@ -119,8 +119,9 @@
119119
</Parameters>
120120
<Docs>
121121
<param name="logLevel">To be added.</param>
122-
<summary>To be added.</summary>
123-
<returns>To be added.</returns>
122+
<summary>Checks if the given <paramref name="logLevel" /> is enabled.</summary>
123+
<returns>
124+
<see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
124125
<remarks>To be added.</remarks>
125126
<inheritdoc />
126127
</Docs>
@@ -165,7 +166,7 @@
165166
<param name="state">To be added.</param>
166167
<param name="exception">To be added.</param>
167168
<param name="formatter">To be added.</param>
168-
<summary>To be added.</summary>
169+
<summary>Writes a log entry.</summary>
169170
<remarks>To be added.</remarks>
170171
<inheritdoc />
171172
</Docs>

‎xml/Microsoft.Extensions.Logging.Abstractions/NullLoggerFactory.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NullLoggerFactory" FullName="Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
1+
<Type Name="NullLoggerFactory" FullName="Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
22
<TypeSignature Language="C#" Value="public class NullLoggerFactory : IDisposable, Microsoft.Extensions.Logging.ILoggerFactory" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NullLoggerFactory extends System.Object implements class Microsoft.Extensions.Logging.ILoggerFactory, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory" />
@@ -78,7 +78,7 @@
7878
</Parameters>
7979
<Docs>
8080
<param name="provider">To be added.</param>
81-
<summary>To be added.</summary>
81+
<summary>Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.</summary>
8282
<remarks>This method ignores the parameter and does nothing.</remarks>
8383
<inheritdoc />
8484
</Docs>
@@ -110,8 +110,8 @@
110110
</Parameters>
111111
<Docs>
112112
<param name="name">To be added.</param>
113-
<summary>To be added.</summary>
114-
<returns>To be added.</returns>
113+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
114+
<returns>A new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</returns>
115115
<remarks>This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" /> instance which logs nothing.</remarks>
116116
<inheritdoc />
117117
</Docs>
@@ -140,7 +140,7 @@
140140
</ReturnValue>
141141
<Parameters />
142142
<Docs>
143-
<summary>To be added.</summary>
143+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
144144
<remarks>To be added.</remarks>
145145
<inheritdoc />
146146
</Docs>

‎xml/Microsoft.Extensions.Logging.Abstractions/NullLoggerProvider.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NullLoggerProvider" FullName="Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
1+
<Type Name="NullLoggerProvider" FullName="Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
22
<TypeSignature Language="C#" Value="public class NullLoggerProvider : IDisposable, Microsoft.Extensions.Logging.ILoggerProvider" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NullLoggerProvider extends System.Object implements class Microsoft.Extensions.Logging.ILoggerProvider, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider" />
@@ -58,8 +58,8 @@
5858
</Parameters>
5959
<Docs>
6060
<param name="categoryName">To be added.</param>
61-
<summary>To be added.</summary>
62-
<returns>To be added.</returns>
61+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
62+
<returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
6363
<remarks>To be added.</remarks>
6464
<inheritdoc />
6565
</Docs>
@@ -89,7 +89,7 @@
8989
</ReturnValue>
9090
<Parameters />
9191
<Docs>
92-
<summary>To be added.</summary>
92+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
9393
<remarks>To be added.</remarks>
9494
<inheritdoc />
9595
</Docs>

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NullLogger&lt;T&gt;" FullName="Microsoft.Extensions.Logging.Abstractions.NullLogger&lt;T&gt;">
1+
<Type Name="NullLogger&lt;T&gt;" FullName="Microsoft.Extensions.Logging.Abstractions.NullLogger&lt;T&gt;">
22
<TypeSignature Language="C#" Value="public class NullLogger&lt;T&gt; : Microsoft.Extensions.Logging.ILogger&lt;T&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NullLogger`1&lt;T&gt; extends System.Object implements class Microsoft.Extensions.Logging.ILogger, class Microsoft.Extensions.Logging.ILogger`1&lt;!T&gt;" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1" />
@@ -86,8 +86,8 @@
8686
<Docs>
8787
<typeparam name="TState">To be added.</typeparam>
8888
<param name="state">To be added.</param>
89-
<summary>To be added.</summary>
90-
<returns>To be added.</returns>
89+
<summary>Begins a logical operation scope.</summary>
90+
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
9191
<remarks>To be added.</remarks>
9292
<inheritdoc />
9393
</Docs>
@@ -143,8 +143,9 @@
143143
</Parameters>
144144
<Docs>
145145
<param name="logLevel">To be added.</param>
146-
<summary>To be added.</summary>
147-
<returns>To be added.</returns>
146+
<summary>Checks if the given <paramref name="logLevel" /> is enabled.</summary>
147+
<returns>
148+
<see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
148149
<remarks>To be added.</remarks>
149150
<inheritdoc />
150151
</Docs>
@@ -188,7 +189,7 @@
188189
<param name="state">To be added.</param>
189190
<param name="exception">To be added.</param>
190191
<param name="formatter">To be added.</param>
191-
<summary>To be added.</summary>
192+
<summary>Writes a log entry.</summary>
192193
<remarks>This method ignores the parameters and does nothing.</remarks>
193194
<inheritdoc />
194195
</Docs>

‎xml/Microsoft.Extensions.Logging.Console.Internal/ConsoleLoggerProcessor.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ConsoleLoggerProcessor" FullName="Microsoft.Extensions.Logging.Console.Internal.ConsoleLoggerProcessor">
1+
<Type Name="ConsoleLoggerProcessor" FullName="Microsoft.Extensions.Logging.Console.Internal.ConsoleLoggerProcessor">
22
<TypeSignature Language="C#" Value="public class ConsoleLoggerProcessor : IDisposable" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConsoleLoggerProcessor extends System.Object implements class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Console.Internal.ConsoleLoggerProcessor" />
@@ -87,7 +87,7 @@
8787
</ReturnValue>
8888
<Parameters />
8989
<Docs>
90-
<summary>To be added.</summary>
90+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
9191
<remarks>To be added.</remarks>
9292
</Docs>
9393
</Member>

‎xml/Microsoft.Extensions.Logging.Console/ConsoleLogger.xml

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ConsoleLogger" FullName="Microsoft.Extensions.Logging.Console.ConsoleLogger">
1+
<Type Name="ConsoleLogger" FullName="Microsoft.Extensions.Logging.Console.ConsoleLogger">
22
<TypeSignature Language="C#" Value="public class ConsoleLogger : Microsoft.Extensions.Logging.ILogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi ConsoleLogger extends System.Object implements class Microsoft.Extensions.Logging.ILogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
@@ -116,9 +116,9 @@
116116
</Parameters>
117117
<Docs>
118118
<typeparam name="TState">To be added.</typeparam>
119-
<param name="state">To be added.</param>
120-
<summary>To be added.</summary>
121-
<returns>To be added.</returns>
119+
<param name="state">The identifier for the scope.</param>
120+
<summary>Begins a logical operation scope.</summary>
121+
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
122122
<remarks>To be added.</remarks>
123123
</Docs>
124124
</Member>
@@ -250,9 +250,10 @@
250250
<Parameter Name="logLevel" Type="Microsoft.Extensions.Logging.LogLevel" Index="0" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
251251
</Parameters>
252252
<Docs>
253-
<param name="logLevel">To be added.</param>
254-
<summary>To be added.</summary>
255-
<returns>To be added.</returns>
253+
<param name="logLevel">level to be checked.</param>
254+
<summary>Checks if the given <paramref name="logLevel" /> is enabled.</summary>
255+
<returns>
256+
<see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
256257
<remarks>To be added.</remarks>
257258
</Docs>
258259
</Member>
@@ -290,12 +291,12 @@
290291
</Parameters>
291292
<Docs>
292293
<typeparam name="TState">To be added.</typeparam>
293-
<param name="logLevel">To be added.</param>
294-
<param name="eventId">To be added.</param>
295-
<param name="state">To be added.</param>
296-
<param name="exception">To be added.</param>
297-
<param name="formatter">To be added.</param>
298-
<summary>To be added.</summary>
294+
<param name="logLevel">Entry will be written on this level.</param>
295+
<param name="eventId">Id of the event.</param>
296+
<param name="state">The entry to be written. Can be also an object.</param>
297+
<param name="exception">The exception related to this entry.</param>
298+
<param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
299+
<summary>Writes a log entry.</summary>
299300
<remarks>To be added.</remarks>
300301
</Docs>
301302
</Member>

‎xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ConsoleLoggerProvider" FullName="Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider">
1+
<Type Name="ConsoleLoggerProvider" FullName="Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider">
22
<TypeSignature Language="C#" Value="public class ConsoleLoggerProvider : IDisposable, Microsoft.Extensions.Logging.ILoggerProvider" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConsoleLoggerProvider extends System.Object implements class Microsoft.Extensions.Logging.ILoggerProvider, class System.IDisposable" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider" />
@@ -191,8 +191,8 @@
191191
</Parameters>
192192
<Docs>
193193
<param name="name">To be added.</param>
194-
<summary>To be added.</summary>
195-
<returns>To be added.</returns>
194+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
195+
<returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
196196
<remarks>To be added.</remarks>
197197
<inheritdoc />
198198
</Docs>
@@ -223,7 +223,7 @@
223223
</ReturnValue>
224224
<Parameters />
225225
<Docs>
226-
<summary>To be added.</summary>
226+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
227227
<remarks>To be added.</remarks>
228228
<inheritdoc />
229229
</Docs>
@@ -254,7 +254,7 @@
254254
</Parameters>
255255
<Docs>
256256
<param name="scopeProvider">To be added.</param>
257-
<summary>To be added.</summary>
257+
<summary>Sets external scope information source for logger provider.</summary>
258258
<remarks>To be added.</remarks>
259259
<inheritdoc />
260260
</Docs>

‎xml/Microsoft.Extensions.Logging.Debug/DebugLogger.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="DebugLogger" FullName="Microsoft.Extensions.Logging.Debug.DebugLogger">
1+
<Type Name="DebugLogger" FullName="Microsoft.Extensions.Logging.Debug.DebugLogger">
22
<TypeSignature Language="C#" Value="public class DebugLogger : Microsoft.Extensions.Logging.ILogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DebugLogger extends System.Object implements class Microsoft.Extensions.Logging.ILogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Debug.DebugLogger" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
@@ -109,8 +109,8 @@
109109
<Docs>
110110
<typeparam name="TState">To be added.</typeparam>
111111
<param name="state">To be added.</param>
112-
<summary>To be added.</summary>
113-
<returns>To be added.</returns>
112+
<summary>Begins a logical operation scope.</summary>
113+
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
114114
<remarks>To be added.</remarks>
115115
<inheritdoc />
116116
</Docs>
@@ -142,8 +142,9 @@
142142
</Parameters>
143143
<Docs>
144144
<param name="logLevel">To be added.</param>
145-
<summary>To be added.</summary>
146-
<returns>To be added.</returns>
145+
<summary>Checks if the given <paramref name="logLevel" /> is enabled.</summary>
146+
<returns>
147+
<see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
147148
<remarks>To be added.</remarks>
148149
<inheritdoc />
149150
</Docs>
@@ -187,7 +188,7 @@
187188
<param name="state">To be added.</param>
188189
<param name="exception">To be added.</param>
189190
<param name="formatter">To be added.</param>
190-
<summary>To be added.</summary>
191+
<summary>Writes a log entry.</summary>
191192
<remarks>To be added.</remarks>
192193
<inheritdoc />
193194
</Docs>

‎xml/Microsoft.Extensions.Logging.Debug/DebugLoggerProvider.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="DebugLoggerProvider" FullName="Microsoft.Extensions.Logging.Debug.DebugLoggerProvider">
1+
<Type Name="DebugLoggerProvider" FullName="Microsoft.Extensions.Logging.Debug.DebugLoggerProvider">
22
<TypeSignature Language="C#" Value="public class DebugLoggerProvider : IDisposable, Microsoft.Extensions.Logging.ILoggerProvider" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DebugLoggerProvider extends System.Object implements class Microsoft.Extensions.Logging.ILoggerProvider, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Debug.DebugLoggerProvider" />
@@ -116,8 +116,8 @@
116116
</Parameters>
117117
<Docs>
118118
<param name="name">To be added.</param>
119-
<summary>To be added.</summary>
120-
<returns>To be added.</returns>
119+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
120+
<returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
121121
<remarks>To be added.</remarks>
122122
<inheritdoc />
123123
</Docs>
@@ -148,7 +148,7 @@
148148
</ReturnValue>
149149
<Parameters />
150150
<Docs>
151-
<summary>To be added.</summary>
151+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
152152
<remarks>To be added.</remarks>
153153
</Docs>
154154
</Member>

0 commit comments

Comments
 (0)