Index: sources/storage/logger.h =================================================================== diff -u -r8c69137f18382bdc55a5678e6ed44a7683fe4dea -r7d23aecac8db9b7495e7d505f55bba5a0d510360 --- sources/storage/logger.h (.../logger.h) (revision 8c69137f18382bdc55a5678e6ed44a7683fe4dea) +++ sources/storage/logger.h (.../logger.h) (revision 7d23aecac8db9b7495e7d505f55bba5a0d510360) @@ -26,6 +26,8 @@ // Define #define _Logger Storage::Logger::I() +#define LOG_EXPORT _Logger.concurrentExport() + #define LOG_EVENT(vCONTENT) emit Storage::Logger::I().didLog(vCONTENT, Storage::Logger::LogType::eLogEvent) #define LOG_EVENT_ONCE_LOGGED \ bLOG_EVENT_ONCE_LOGGED @@ -63,14 +65,17 @@ namespace Storage { /*! - * \brief The Logger class - * + * \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_ERROR, LOG_EXPORT defines + * and no other methods. + * This should have it's own thread. * \note - * PLEASE BE CAREFUL THIS CLASS IS USING QtConcurrent::run - * IT MEANS ANY OTHER CALL WILL BE DONE IN MAIN THREAD + * 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 AND DO NOT ADD SIGNAL/SLOTS OR ANY OTHER FUNCTION CALLS. - * ALL THE OTHER CLASSES TO USE THIS CLASS SHOULD ONLY USE LOG_DATUM, LOG_EVENT, LOG_ERROR TO LOG + * PLEASE BE VERY CAREFUL. + * ALL THE OTHER CLASSES TO USE THIS CLASS SHOULD ONLY USE LOG_DATUM, LOG_EVENT, LOG_ERROR + * TO DO THE LOGGING */ class Logger : public QObject { @@ -143,6 +148,10 @@ private slots: void onExport(); signals: + /*! + * \brief didExport + * \details notifies the UI when the export is done. + */ void didExport(); // ----- logging structure @@ -151,7 +160,13 @@ private: void log (const QString &vContent, LogType vLogType); signals: - void didLog (const QString &vContent, LogType vLogType); + /*! + * \brief didLog + * \details Notifies the logger on a request for log + * \param vContent - content as type of string to be logged + * \param vLogType - the type of logging of type Storage::Logger::LogType + */ + void didLog (const QString &vContent, LogType vLogType); }; }