Skip to content
This repository was archived by the owner on Dec 13, 2018. It is now read-only.

Commit 6f6940d

Browse files
committed
Added doc comments for main APIs:
- Coherence-Signed#75
1 parent 718ac11 commit 6f6940d

File tree

5 files changed

+50
-12
lines changed

5 files changed

+50
-12
lines changed

src/Microsoft.Extensions.Logging.Abstractions/ILogger.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Microsoft.Extensions.Logging
77
{
88
/// <summary>
9-
/// A generic interface for logging.
9+
/// Represents a type used to perform logging.
1010
/// </summary>
1111
public interface ILogger
1212
{

src/Microsoft.Extensions.Logging.Abstractions/ILoggerFactory.cs

+10-5
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,27 @@
66
namespace Microsoft.Extensions.Logging
77
{
88
/// <summary>
9-
/// Used to create logger instances of the given name.
9+
/// Represents a type used to configure the logging system and create instances of <see cref="ILogger"/> from
10+
/// the registered <see cref="ILoggerProvider"/>s.
1011
/// </summary>
1112
public interface ILoggerFactory : IDisposable
1213
{
1314
/// <summary>
14-
/// The minimum level of log messages sent to registered loggers.
15+
/// The minimum level of log messages sent to loggers.
1516
/// </summary>
1617
LogLevel MinimumLevel { get; set; }
1718

1819
/// <summary>
19-
/// Creates a new ILogger instance of the given name.
20+
/// Creates a new <see cref="ILogger"/> instance.
2021
/// </summary>
21-
/// <param name="categoryName"></param>
22-
/// <returns></returns>
22+
/// <param name="categoryName">The category name for messages produced by the logger.</param>
23+
/// <returns>The <see cref="ILogger"/>.</returns>
2324
ILogger CreateLogger(string categoryName);
2425

26+
/// <summary>
27+
/// Adds an <see cref="ILoggerProvider"/> to the logging system.
28+
/// </summary>
29+
/// <param name="provider">The <see cref="ILoggerProvider"/>.</param>
2530
void AddProvider(ILoggerProvider provider);
2631
}
2732
}

src/Microsoft.Extensions.Logging.Abstractions/ILoggerOfT.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66
namespace Microsoft.Extensions.Logging
77
{
88
/// <summary>
9-
/// A generic interface for logging where the category name is taken from the specified TCategoryName.
10-
/// For enabling activation of named ILogger from DI.
9+
/// A generic interface for logging where the category name is derived from the specified
10+
/// <paramref name="TCategoryName"/> type name.
11+
/// Generally used to enable activation of a named <see cref="ILogger"/> from dependency injection.
1112
/// </summary>
13+
/// <typeparam name="TCategoryName">The type who's name is used for the logger category name.</typeparam>
1214
public interface ILogger<out TCategoryName> : ILogger
1315
{
1416

src/Microsoft.Extensions.Logging.Abstractions/ILoggerProvider.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
namespace Microsoft.Extensions.Logging
77
{
88
/// <summary>
9-
/// Used to create logger instances of the given name.
9+
/// Represents a type that can create instances of <see cref="ILogger"/>.
1010
/// </summary>
1111
public interface ILoggerProvider : IDisposable
1212
{
1313
/// <summary>
14-
/// Creates a new ILogger instance of the given name.
14+
/// Creates a new <see cref="ILogger"/> instance.
1515
/// </summary>
16-
/// <param name="name"></param>
16+
/// <param name="categoryName">The category name for messages produced by the logger.</param>
1717
/// <returns></returns>
18-
ILogger CreateLogger(string name);
18+
ILogger CreateLogger(string categoryName);
1919
}
2020
}

src/Microsoft.Extensions.Logging.Abstractions/LogLevel.cs

+31
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,44 @@
33

44
namespace Microsoft.Extensions.Logging
55
{
6+
/// <summary>
7+
/// Defines logging severity levels.
8+
/// </summary>
69
public enum LogLevel
710
{
11+
/// <summary>
12+
/// Logs that contain the most detailed messages. These messages may contain sensitive application data.
13+
/// These messages are disabled by default and should never be enabled in a production environment.
14+
/// </summary>
815
Debug = 1,
16+
17+
/// <summary>
18+
/// Logs that are used for interactive investigation during development. These logs should primarily contain
19+
/// information useful for debugging and have no long-term value.
20+
/// </summary>
921
Verbose = 2,
22+
23+
/// <summary>
24+
/// Logs that track the general flow of the application. These logs should have long-term value.
25+
/// </summary>
1026
Information = 3,
27+
28+
/// <summary>
29+
/// Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
30+
/// application execution to stop.
31+
/// </summary>
1132
Warning = 4,
33+
34+
/// <summary>
35+
/// Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
36+
/// failure in the current activity, not an application-wide failure.
37+
/// </summary>
1238
Error = 5,
39+
40+
/// <summary>
41+
/// Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
42+
/// immediate attention.
43+
/// </summary>
1344
Critical = 6,
1445
}
1546
}

0 commit comments

Comments
 (0)