From 79d1da058312fc32303d169bbcae27e9c17b58f9 Mon Sep 17 00:00:00 2001
From: Matt Nadareski <mnadareski@outlook.com>
Date: Sun, 22 May 2016 23:57:44 -0700
Subject: [PATCH] [doc] notes for Logging

---
 SabreHelper/Logger.cs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/SabreHelper/Logger.cs b/SabreHelper/Logger.cs
index 2551fa29..9a885b69 100644
--- a/SabreHelper/Logger.cs
+++ b/SabreHelper/Logger.cs
@@ -6,6 +6,13 @@ namespace SabreTools.Helper
 	/// <summary>
 	/// Log either to file or to the console
 	/// </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
 	{
 		// Private instance variables
@@ -139,6 +146,11 @@ namespace SabreTools.Helper
 			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)
 		{
 			return Log(output, LogLevel.USER);