added comment on logmanager:

GRIDAPPSD · Nov 30, 2017 · c6f3cd9 · c6f3cd9
1 parent f6a340f
commit c6f3cd9
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/gov.pnnl.goss.gridappsd/src/gov/pnnl/goss/gridappsd/api/LogManager.java b/gov.pnnl.goss.gridappsd/src/gov/pnnl/goss/gridappsd/api/LogManager.java
@@ -43,7 +43,13 @@
 
 public interface LogManager {
 
-
+	/**
+	 * Implementation of this method should writes the message in log file. 
+	 * And calls LogDataManager to save the log  message in data store if 
+	 * store_to_db is true in  LogMessage object.  
+	 * @param message an Object of gov.pnnl.goss.gridappsd.dto.LogMessage
+	 * @param username username of the user logging the message
+	 */
 	void log(LogMessage message, String username);
 
 	/**