From 6f4cdf61dae3a6be848c524fc66e2bd86711d82e Mon Sep 17 00:00:00 2001
From: plafosse <peter@vector35.com>
Date: Wed, 29 Jun 2016 17:49:36 -0400
Subject: Adding initial documentation for c++

---
 binaryninjacore.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

(limited to 'binaryninjacore.h')

diff --git a/binaryninjacore.h b/binaryninjacore.h
index 20f1b204..6a1e6a63 100644
--- a/binaryninjacore.h
+++ b/binaryninjacore.h
@@ -97,13 +97,14 @@ extern "C"
 	struct BNPlatform;
 	struct BNAnalysisCompletionEvent;
 
+	//! Console log levels
 	enum BNLogLevel
 	{
-		DebugLog = 0,
-		InfoLog = 1,
-		WarningLog = 2,
-		ErrorLog = 3,
-		AlertLog = 4
+		DebugLog = 0,   //!< Debug logging level, most verbose logging level
+		InfoLog = 1,    //!< Information logging level, default logging level
+		WarningLog = 2, //!< Warning logging level, messages show with warning icon in the UI
+		ErrorLog = 3,   //!< Error logging level, messages show with error icon in the UI
+		AlertLog = 4    //!< Alert logging level, messages are displayed with popup message box in the UI
 	};
 
 	enum BNEndianness
-- 
cgit v1.3.1