log: add doxygen comments

1 files changed, 58 insertions, 0 deletions

diff --git a/src/log.c b/src/log.c
index 650689d..8047a05 100644
--- a/src/log.c
+++ b/src/log.c
@@ -21,6 +21,11 @@ static struct {
 };
 
 
+/**
+ * Register a log handler
+ *
+ * @param log Log handler
+ */
 void log_register_handler(struct log *log)
 {
 	if (!log)
@@ -30,6 +35,11 @@ void log_register_handler(struct log *log)
 }
 
 
+/**
+ * Unregister a log handler
+ *
+ * @param log Log handler
+ */
 void log_unregister_handler(struct log *log)
 {
 	if (!log)
@@ -39,12 +49,22 @@ void log_unregister_handler(struct log *log)
 }
 
 
+/**
+ * Enable debug-level logging
+ *
+ * @param enable True to enable, false to disable
+ */
 void log_enable_debug(bool enable)
 {
 	lg.debug = enable;
 }
 
 
+/**
+ * Enable info-level logging
+ *
+ * @param enable True to enable, false to disable
+ */
 void log_enable_info(bool enable)
 {
 	lg.info = enable;
@@ -57,6 +77,13 @@ void log_enable_stderr(bool enable)
 }
 
 
+/**
+ * Print a message to the logging system
+ *
+ * @param level Log level
+ * @param fmt   Formatted message
+ * @param ap    Variable argument list
+ */
 void vlog(enum log_level level, const char *fmt, va_list ap)
 {
 	char buf[4096];
@@ -91,6 +118,13 @@ void vlog(enum log_level level, const char *fmt, va_list ap)
 }
 
 
+/**
+ * Print a message to the logging system
+ *
+ * @param level Log level
+ * @param fmt   Formatted message
+ * @param ...   Variable arguments
+ */
 void loglv(enum log_level level, const char *fmt, ...)
 {
 	va_list ap;
@@ -107,6 +141,12 @@ void loglv(enum log_level level, const char *fmt, ...)
 }
 
 
+/**
+ * Print a DEBUG message to the logging system
+ *
+ * @param fmt   Formatted message
+ * @param ...   Variable arguments
+ */
 void debug(const char *fmt, ...)
 {
 	va_list ap;
@@ -120,6 +160,12 @@ void debug(const char *fmt, ...)
 }
 
 
+/**
+ * Print an INFO message to the logging system
+ *
+ * @param fmt   Formatted message
+ * @param ...   Variable arguments
+ */
 void info(const char *fmt, ...)
 {
 	va_list ap;
@@ -133,6 +179,12 @@ void info(const char *fmt, ...)
 }
 
 
+/**
+ * Print a WARNING message to the logging system
+ *
+ * @param fmt   Formatted message
+ * @param ...   Variable arguments
+ */
 void warning(const char *fmt, ...)
 {
 	va_list ap;
@@ -143,6 +195,12 @@ void warning(const char *fmt, ...)
 }
 
 
+/**
+ * Print an ERROR message to the logging system
+ *
+ * @param fmt   Formatted message
+ * @param ...   Variable arguments
+ */
 void error_msg(const char *fmt, ...)
 {
 	va_list ap;