Changeset e0c836e8 in mainline for uspace/lib/c/include/io/log.h

Timestamp:

2012-09-07T08:29:43Z (12 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

42bde6a

Parents:

70253688

Message:

Add comments to logging interface in libc

File:

• uspace/lib/c/include/io/log.h (modified) (2 diffs)

uspace/lib/c/include/io/log.h

@@ -39 +39 @@
 #include <io/verify.h>
 
+/** Log message level. */
 typedef enum {
+        /** Fatal error, program is not able to recover at all. */
         LVL_FATAL,
+        /** Serious error but the program can recover from it. */
         LVL_ERROR,
+        /** Easily recoverable problem. */
         LVL_WARN,
+        /** Information message that ought to be printed by default. */
         LVL_NOTE,
+        /** Debugging purpose message. */
         LVL_DEBUG,
+        /** More detailed debugging message. */
         LVL_DEBUG2,
         
@@ -51 +58 @@
 } log_level_t;
 
+/** Log itself (logging target). */
 typedef sysarg_t log_t;
+/** Formatting directive for printing log_t. */
 #define PRIlogctx PRIxn
+
+/** Default log (target). */
 #define LOG_DEFAULT ((log_t) -1)
+
+/** Use when creating new top-level log. */
 #define LOG_NO_PARENT ((log_t) 0)