Tidy up and activate the MSVC Debug Heap

BeastConfig.h

@@ -20,30 +20,109 @@
 #ifndef BEAST_BEASTCONFIG_H_INCLUDED
 #define BEAST_BEASTCONFIG_H_INCLUDED
 
-// beast_core flags:
+/** Configuration file for Beast.
 
-#ifndef    BEAST_FORCE_DEBUG
- //#define BEAST_FORCE_DEBUG
+    This sets various configurable options for Beast. In order to compile you
+    must place a copy of this file in a location where your build environment
+    can find it, and then customize its contents to suit your needs.
+
+    @file BeastConfig.h
+*/
+
+//------------------------------------------------------------------------------
+
+/** Config: BEAST_FORCE_DEBUG
+
+    Normally, BEAST_DEBUG is set to 1 or 0 based on compiler and project
+    settings, but if you define this value, you can override this to force it
+    to be true or false.
+*/
+#ifndef   BEAST_FORCE_DEBUG
+//#define BEAST_FORCE_DEBUG 0
 #endif
 
-#ifndef    BEAST_LOG_ASSERTIONS
- //#define BEAST_LOG_ASSERTIONS 1
+//------------------------------------------------------------------------------
+
+/** Config: BEAST_LOG_ASSERTIONS
+
+    If this flag is enabled, the the bassert and bassertfalse macros will always
+    use Logger::writeToLog() to write a message when an assertion happens.
+
+    Enabling it will also leave this turned on in release builds. When it's
+    disabled, however, the bassert and bassertfalse macros will not be compiled
+    in a release build.
+
+    @see bassert, bassertfalse, Logger
+*/
+#ifndef   BEAST_LOG_ASSERTIONS
+//#define BEAST_LOG_ASSERTIONS 0
 #endif
 
+//------------------------------------------------------------------------------
+
+/** Config: BEAST_CHECK_MEMORY_LEAKS
+
+    Enables a memory-leak check for certain objects when the app terminates.
+    See the LeakedObjectDetector and LeakChecked classes, and the
+    BEAST_LEAK_DETECTOR macro for more details about enabling leak checking for
+    specific classes.
+*/
 #ifndef BEAST_CHECK_MEMORY_LEAKS
 #define BEAST_CHECK_MEMORY_LEAKS 1
 #endif
 
-#ifndef    BEAST_DONT_AUTOLINK_TO_WIN32_LIBRARIES
- //#define BEAST_DONT_AUTOLINK_TO_WIN32_LIBRARIES
+//------------------------------------------------------------------------------
+
+/** Config: BEAST_DONT_AUTOLINK_TO_WIN32_LIBRARIES
+
+    In a Visual C++  build, this can be used to stop the required system libs
+    being automatically added to the link stage.
+*/
+#ifndef   BEAST_DONT_AUTOLINK_TO_WIN32_LIBRARIES
+//#define BEAST_DONT_AUTOLINK_TO_WIN32_LIBRARIES 1
 #endif
 
-// beast_basics flags
+//------------------------------------------------------------------------------
 
+/** Config: BEAST_INCLUDE_ZLIB_CODE
+
+    This can be used to disable Beast's embedded 3rd-party zlib code.
+    You might need to tweak this if you're linking to an external zlib library in your app,
+    but for normal apps, this option should be left alone.
+
+    If you disable this, you might also want to set a value for BEAST_ZLIB_INCLUDE_PATH, to
+    specify the path where your zlib headers live.
+*/
+#ifndef   BEAST_INCLUDE_ZLIB_CODE
+//#define BEAST_INCLUDE_ZLIB_CODE 0
+#endif
+
+#ifndef BEAST_ZLIB_INCLUDE_PATH
+#define BEAST_ZLIB_INCLUDE_PATH <zlib.h>
+#endif
+
+//------------------------------------------------------------------------------
+
+/** Config: BEAST_BOOST_IS_AVAILABLE
+
+    This activates boost specific features and improvements.
+*/
+#ifndef BEAST_BOOST_IS_AVAILABLE
 #define BEAST_BOOST_IS_AVAILABLE 1
+#endif
+
+/** Bind source configuration.
+
+    Set one of these to manually force a particular implementation of bind().
+    If nothing is chosen then beast will use whatever is appropriate for your
+    environment based on what is available.
+*/
+//#define BEAST_BIND_USES_STD   1
+//#define BEAST_BIND_USES_TR1   1
+//#define BEAST_BIND_USES_BOOST 1
 
 #ifndef BEAST_USE_LEAKCHECKED
-#define BEAST_USE_LEAKCHECKED BEAST_CHECK_MEMORY_LEAKS
+#define BEAST_USE_LEAKCHECKED 1
 #endif
 
 #endif