Doxygen: Initial groups and topic short descriptions.

[libsigrokdecode.git] / log.c

diff --git a/log.c b/log.c
index 81e9251ba06a9d4d8a74cfe6130b4e13efc2c454..95e3535723c0319f699b50558629ddc48fba0023 100644 (file)
--- a/log.c
+++ b/log.c
@@ -23,6 +23,20 @@
 #include <stdarg.h>
 #include <stdio.h>
 
+/**
+ * @file
+ *
+ * Controlling the libsigrokdecode message logging functionality.
+ */
+
+/**
+ * @defgroup grp_logging Logging
+ *
+ * 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 +54,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 +209,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 +222,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 +236,7 @@ SRD_PRIV int srd_spew(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_dbg(const char *format, ...)
 {
        int ret;
@@ -231,6 +250,7 @@ SRD_PRIV int srd_dbg(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_info(const char *format, ...)
 {
        int ret;
@@ -244,6 +264,7 @@ SRD_PRIV int srd_info(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_warn(const char *format, ...)
 {
        int ret;
@@ -257,6 +278,7 @@ SRD_PRIV int srd_warn(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_err(const char *format, ...)
 {
        int ret;
@@ -269,3 +291,5 @@ SRD_PRIV int srd_err(const char *format, ...)
 
        return ret;
 }
+
+/** @} */