diff CollidoscopeApp/include/Log.h @ 3:7fb593d53361

added comments
author Fiore Martin <f.martin@qmul.ac.uk>
date Tue, 12 Jul 2016 18:29:38 +0200
parents 02467299402e
children 75b744078d66
line wrap: on
line diff
--- a/CollidoscopeApp/include/Log.h	Mon Jul 11 17:03:40 2016 +0200
+++ b/CollidoscopeApp/include/Log.h	Tue Jul 12 18:29:38 2016 +0200
@@ -1,8 +1,17 @@
 #pragma once 
 
 
-
+/**
+ * Utility function to log errors using the cinder::log library.
+ * Errors are logged to collidoscope_error.log file. 
+ *
+ */ 
 void logError( const std::string &errorMsg );
 
 
-void logInfo( const std::string &infoMsg );
\ No newline at end of file
+/**
+ * Utility function to log info using the cinder::log library.
+ * Errors are logged to the terminal. Used only for debugging.
+ *
+ */ 
+void logInfo( const std::string &infoMsg );