More logging docs

This commit is contained in:
Nils O. Selåsdal
2012-10-31 21:29:36 +01:00
parent 429b8acfd6
commit 449a31f55b
+9
View File
@@ -1,6 +1,12 @@
#ifndef UCORE_LOGGING_H_
#define UCORE_LOGGING_H_
/** Logging functions.
* All logging functions except uc_log_init are thread safe,
* so logging can be performed from any thread after the logging
* system have been initialized.
*/
/** The log levels defined by ucore logging*/
enum UC_LOG_LEVEL {
UC_LL_NONE = 0,
@@ -139,6 +145,9 @@ void uc_logf(int log_level, int module, const char *file, int line, const char *
#endif
/** Main macro that should be used for logging.
*
* For log messages with UC_LL_DEBUG, the UC_DEBUGF() macro can be used,
* UC_DEBUGF will only be compiled in if the DEBUG macro is defined
*
* @lvl log level of this log message
* @mod module id of this log messagex.