Index: sources/storage/Logger.h =================================================================== diff -u -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 -r84c5373209a1a488c00917995f5553d442d159a4 --- sources/storage/Logger.h (.../Logger.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) +++ sources/storage/Logger.h (.../Logger.h) (revision 84c5373209a1a488c00917995f5553d442d159a4) @@ -43,15 +43,27 @@ /*! * \brief The Logger class * \details Main logger class that has all the required implementation for logging. - * The provided interface is the LOG_DATUM, LOG_EVENT, LOG_DEBUG, LOG_EXPORT defines - * and no other methods. - * This should have its own thread. + * The provided interface is the LOG_DATUM, LOG_EVENT, LOG_DEBUG, LOG_EXPORT defines + * and no other methods. + * + * This object is logging all the registered Denali Messages transactions over the CANBus in CSV format text file. + * Logger class currently has 3 types which are Event, Error, Datum. + * The Event and Data messages are logged in the csv file with "log" extension + * and the UI Application specific errors are logged in a csv file with the "err" extension. + * Logs file names format start with current system date by "" format and "_denali.". + * The content of the file is depending on each log type and has ",,,,". + * Currently, the file name and content formatting can be modified by changing the formatting values in Logger class. + * + * This class has its own thread for logging. + * Also for exporting the log files it uses asynchronous thread calling by QtConcurrent. + * It communicated with other classes only with Signal/Slots for thread safety and will notify other classes when the export is done by signals. + * * \note - * PLEASE BE CAREFUL THIS CLASS IS USING QtConcurrent::run FOR THE EXPORT LOG FILES. - * AND ONLY PRIVATE VOID LOG (,) IS CALLING IN POOLED THREAD - * PLEASE BE VERY CAREFUL. - * ALL THE OTHER CLASSES TO USE THIS CLASS SHOULD ONLY USE LOG_DATUM, LOG_EVENT, LOG_DEBUG - * TO DO THE LOGGING + * PLEASE BE CAREFUL THIS CLASS IS USING QtConcurrent::run FOR THE EXPORT LOG FILES. + * AND ONLY PRIVATE VOID LOG (,) IS CALLING IN POOLED THREAD + * PLEASE BE VERY CAREFUL. + * ALL THE OTHER CLASSES TO USE THIS CLASS SHOULD ONLY USE LOG_DATUM, LOG_EVENT, LOG_DEBUG + * TO DO THE LOGGING */ class Logger : public QObject {