[doc] notes for Logging

This commit is contained in:
Matt Nadareski
2016-05-22 23:57:44 -07:00
parent 4d1b83b704
commit 79d1da0583

View File

@@ -6,6 +6,13 @@ namespace SabreTools.Helper
/// <summary> /// <summary>
/// Log either to file or to the console /// Log either to file or to the console
/// </summary> /// </summary>
/// <remarks>
/// Things to do:
/// - Create log files by date
/// - Clean up log files if there are more than x number per program
/// - Allow for "triggerable" logging done on an interval (async)
/// - Log filtering?
/// </remarks>
public class Logger public class Logger
{ {
// Private instance variables // Private instance variables
@@ -139,6 +146,11 @@ namespace SabreTools.Helper
return true; return true;
} }
/// <summary>
/// Write the given string as a user message to the log output
/// </summary>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public bool User(string output) public bool User(string output)
{ {
return Log(output, LogLevel.USER); return Log(output, LogLevel.USER);