Add and cleanup some of the API documentation.

2010-07-05 15:57:24 +00:00
parent 2818311a94
commit e8b10fd2b9
8 changed files with 89 additions and 40 deletions
--- a/library/PolyVoxCore/include/Log.h
+++ b/library/PolyVoxCore/include/Log.h
@ -34,9 +34,12 @@ freely, subject to the following restrictions:

 namespace PolyVox
 {
+	////////////////////////////////////////////////////////////////////////////////
+	/// Log levels for filtering logging events
+	////////////////////////////////////////////////////////////////////////////////
 	enum LogSeverity
 	{
-		LS_DEBUG,
+		LS_DEBUG, ///< Only displayed if it is a debug build
 		LS_INFO,
 		LS_WARN,
 		LS_ERROR