From fc27d8ccd2440f7ff1ce08b11bec432a9c922b72 Mon Sep 17 00:00:00 2001
From: "Jason A. Donenfeld" <Jason@zx2c4.com>
Date: Wed, 4 Nov 2020 18:23:47 +0100
Subject: api: document log enum

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
---
 api/wintun.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'api')

diff --git a/api/wintun.h b/api/wintun.h
index f957fac..54c27cd 100644
--- a/api/wintun.h
+++ b/api/wintun.h
@@ -189,11 +189,14 @@ typedef _Return_type_success_(return != FALSE)
  */
 typedef DWORD(WINAPI *WINTUN_GET_RUNNING_DRIVER_VERSION_FUNC)(void);
 
+/**
+ * Determines the level of logging, passed to WINTUN_LOGGER_CALLBACK.
+ */
 typedef enum
 {
-    WINTUN_LOG_INFO = 0,
-    WINTUN_LOG_WARN,
-    WINTUN_LOG_ERR
+    WINTUN_LOG_INFO, /**< Informational */
+    WINTUN_LOG_WARN, /**< Warning */
+    WINTUN_LOG_ERR   /**< Error */
 } WINTUN_LOGGER_LEVEL;
 
 /**
-- 
cgit v1.2.3-59-g8ed1b