Changeset e0c836e8 in mainline for uspace/lib/c/generic/io/logctl.c

Timestamp:

2012-09-07T08:29:43Z (13 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/generic/io/logctl.c (modified) (2 diffs)

uspace/lib/c/generic/io/logctl.c

@@ -65 +65 @@
 }
 
-
+/** Set default reported log level (global setting).
+ *
+ * This setting affects all logger clients whose reporting level was
+ * not yet changed.
+ *
+ * If logging level of client A is changed with logctl_set_log_level()
+ * to some level, this call will have no effect at that client's reporting
+ * level. Even if the actual value of the reporting level of client A is
+ * the same as current (previous) default log level.
+ *
+ * @param new_level New reported logging level.
+ * @return Error code of the conversion or EOK on success.
+ */
 int logctl_set_default_level(log_level_t new_level)
 {
@@ -81 +93 @@
 }
 
+/** Set reported log level of a single log.
+ *
+ * @see logctl_set_default_level
+ *
+ * @param logname Log name.
+ * @param new_level New reported logging level.
+ * @return Error code of the conversion or EOK on success.
+ */
 int logctl_set_log_level(const char *logname, log_level_t new_level)
 {