sr: Doxygen comments for loglevels.

[libsigrok.git] / sigrok.h.in

diff --git a/sigrok.h.in b/sigrok.h.in
index a767dc71bceb980746a46ec412309076096a38da..5e42011cc81dd3c7368e7604d4acab8e9c7a6714 100644 (file)
--- a/sigrok.h.in
+++ b/sigrok.h.in
@@ -66,12 +66,12 @@ extern "C" {
 #define SR_HZ_TO_NS(n) (1000000000 / (n))
 
 /* libsigrok loglevels. */
-#define SR_LOG_NONE     0
-#define SR_LOG_ERR      1
-#define SR_LOG_WARN     2
-#define SR_LOG_INFO     3
-#define SR_LOG_DBG      4
-#define SR_LOG_SPEW     5
+#define SR_LOG_NONE    0 /**< Output no messages at all. */
+#define SR_LOG_ERR     1 /**< Output error messages. */
+#define SR_LOG_WARN    2 /**< Output warnings. */
+#define SR_LOG_INFO    3 /**< Output informational messages. */
+#define SR_LOG_DBG     4 /**< Output debug messages. */
+#define SR_LOG_SPEW    5 /**< Output very noisy debug messages. */
 
 /*
  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.