prehistoric-systems/Flow.Launcher
1
0
Fork 0
mirror of https://github.com/Flow-Launcher/Flow.Launcher.git synced 2026-03-11 08:54:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #2081 from VictoriousRaptor/FixLogDocstring

Browse source 
Fix Log methods' docstring
This commit is contained in:
VictoriousRaptor 2023-04-23 06:19:29 +08:00 committed by GitHub
commit 59b9cd8dbd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
Flow.Launcher.Infrastructure/Logger/Log.cs
View file

@ -5,11 +5,9 @@ using NLog;
using NLog.Config; using NLog.Config;
using NLog.Targets; using NLog.Targets;
using Flow.Launcher.Infrastructure.UserSettings; using Flow.Launcher.Infrastructure.UserSettings;
using JetBrains.Annotations;
using NLog.Fluent; using NLog.Fluent;
using NLog.Targets.Wrappers; using NLog.Targets.Wrappers;
using System.Runtime.ExceptionServices; using System.Runtime.ExceptionServices;
using System.Text;
namespace Flow.Launcher.Infrastructure.Logger namespace Flow.Launcher.Infrastructure.Logger
{ {
@ -76,7 +74,6 @@ namespace Flow.Launcher.Infrastructure.Logger
return valid; return valid;
} }
public static void Exception(string className, string message, System.Exception exception, [CallerMemberName] string methodName = "") public static void Exception(string className, string message, System.Exception exception, [CallerMemberName] string methodName = "")
{ {
exception = exception.Demystify(); exception = exception.Demystify();
@ -115,8 +112,6 @@ namespace Flow.Launcher.Infrastructure.Logger
{ {
var logger = LogManager.GetLogger(classAndMethod); var logger = LogManager.GetLogger(classAndMethod);
var messageBuilder = new StringBuilder();
logger.Error(e, message); logger.Error(e, message);
} }
@ -136,7 +131,8 @@ namespace Flow.Launcher.Infrastructure.Logger
} }
} }
/// <param name="message">example: "|prefix|unprefixed" </param> /// Example: "|ClassName.MethodName|Message"
/// <param name="message">Example: "|ClassName.MethodName|Message" </param>
/// <param name="e">Exception</param> /// <param name="e">Exception</param>
public static void Exception(string message, System.Exception e) public static void Exception(string message, System.Exception e)
{ {
@ -158,7 +154,7 @@ namespace Flow.Launcher.Infrastructure.Logger
#endif #endif
} }
/// <param name="message">example: "|prefix|unprefixed" </param> /// Example: "|ClassName.MethodName|Message"
public static void Error(string message) public static void Error(string message)
{ {
LogInternal(message, LogLevel.Error); LogInternal(message, LogLevel.Error);
@ -183,7 +179,7 @@ namespace Flow.Launcher.Infrastructure.Logger
LogInternal(LogLevel.Debug, className, message, methodName); LogInternal(LogLevel.Debug, className, message, methodName);
} }
/// <param name="message">example: "|prefix|unprefixed" </param> /// Example: "|ClassName.MethodName|Message""
public static void Debug(string message) public static void Debug(string message)
{ {
LogInternal(message, LogLevel.Debug); LogInternal(message, LogLevel.Debug);
@ -194,7 +190,7 @@ namespace Flow.Launcher.Infrastructure.Logger
LogInternal(LogLevel.Info, className, message, methodName); LogInternal(LogLevel.Info, className, message, methodName);
} }
/// <param name="message">example: "|prefix|unprefixed" </param> /// Example: "|ClassName.MethodName|Message"
public static void Info(string message) public static void Info(string message)
{ {
LogInternal(message, LogLevel.Info); LogInternal(message, LogLevel.Info);
@ -205,7 +201,7 @@ namespace Flow.Launcher.Infrastructure.Logger
LogInternal(LogLevel.Warn, className, message, methodName); LogInternal(LogLevel.Warn, className, message, methodName);
} }
/// <param name="message">example: "|prefix|unprefixed" </param> /// Example: "|ClassName.MethodName|Message"
public static void Warn(string message) public static void Warn(string message)
{ {
LogInternal(message, LogLevel.Warn); LogInternal(message, LogLevel.Warn);