Skip to content

Commit f8cba16

Browse files
committed
docs(xml): Added missing XML documentation to MLAPI log classes and methods
1 parent 759daf2 commit f8cba16

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

MLAPI/NetworkingManagerComponents/Core/LogHelper.cs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,38 @@
22

33
namespace MLAPI.Logging
44
{
5+
/// <summary>
6+
/// Log level
7+
/// </summary>
58
public enum LogLevel
69
{
10+
/// <summary>
11+
/// Developer logging level, most verbose
12+
/// </summary>
713
Developer,
14+
/// <summary>
15+
/// Normal logging level, medium verbose
16+
/// </summary>
817
Normal,
18+
/// <summary>
19+
/// Error logging level, very quiet
20+
/// </summary>
921
Error,
22+
/// <summary>
23+
/// Nothing logging level, no logging will be done
24+
/// </summary>
1025
Nothing
1126
}
1227

28+
/// <summary>
29+
/// Helper class for logging
30+
/// </summary>
1331
public static class LogHelper
1432
{
33+
/// <summary>
34+
/// Gets the current log level.
35+
/// </summary>
36+
/// <value>The current log level.</value>
1537
public static LogLevel CurrentLogLevel
1638
{
1739
get
@@ -23,8 +45,20 @@ public static LogLevel CurrentLogLevel
2345
}
2446
}
2547

48+
/// <summary>
49+
/// Logs an info log with the proper MLAPI prefix
50+
/// </summary>
51+
/// <param name="message">The message to log</param>
2652
public static void LogInfo(string message) => Debug.Log("[MLAPI] " + message);
53+
/// <summary>
54+
/// Logs a warning log with the proper MLAPI prefix
55+
/// </summary>
56+
/// <param name="message">The message to log</param>
2757
public static void LogWarning(string message) => Debug.LogWarning("[MLAPI] " + message);
58+
/// <summary>
59+
/// Logs an error log with the proper MLAPI prefix
60+
/// </summary>
61+
/// <param name="message">The message to log</param>
2862
public static void LogError(string message) => Debug.LogError("[MLAPI] " + message);
2963
}
3064
}

0 commit comments

Comments
 (0)