Doxygen: Add @file items for the relevant files.

[libsigrokdecode.git] / log.c

diff --git a/log.c b/log.c
index 81e9251ba06a9d4d8a74cfe6130b4e13efc2c454..e68014cd52d52a49c4db8afa0b00b170679e50e8 100644 (file)
--- a/log.c
+++ b/log.c
@@ -23,6 +23,12 @@
 #include <stdarg.h>
 #include <stdio.h>
 
+/**
+ * @file
+ *
+ * Controlling the libsigrokdecode message logging functionality.
+ */
+
 /* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */
 static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */
 
@@ -40,8 +46,10 @@ static srd_log_callback_t srd_log_callback = srd_logv;
 static void *srd_log_callback_data = NULL;
 
 /* Log domain (a short string that is used as prefix for all messages). */
+/** @cond PRIVATE */
 #define LOGDOMAIN_MAXLEN 30
 #define LOGDOMAIN_DEFAULT "srd: "
+/** @endcond */
 static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
 
 /**
@@ -193,6 +201,7 @@ static int srd_logv(void *cb_data, int loglevel, const char *format,
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
 {
        int ret;
@@ -205,6 +214,7 @@ SRD_PRIV int srd_log(int loglevel, const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_spew(const char *format, ...)
 {
        int ret;
@@ -218,6 +228,7 @@ SRD_PRIV int srd_spew(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_dbg(const char *format, ...)
 {
        int ret;
@@ -231,6 +242,7 @@ SRD_PRIV int srd_dbg(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_info(const char *format, ...)
 {
        int ret;
@@ -244,6 +256,7 @@ SRD_PRIV int srd_info(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_warn(const char *format, ...)
 {
        int ret;
@@ -257,6 +270,7 @@ SRD_PRIV int srd_warn(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_err(const char *format, ...)
 {
        int ret;