Browse Source

Add note on usage of DebugNew.h. Closes #1879.

Lasse Öörni 8 years ago
parent
commit
9df8cfd0a8
1 changed files with 5 additions and 0 deletions
  1. 5 0
      Source/Urho3D/DebugNew.h

+ 5 - 0
Source/Urho3D/DebugNew.h

@@ -20,6 +20,11 @@
 // THE SOFTWARE.
 //
 
+// This file overrides global new to provide file and line information to allocations for easier memory leak detection on MSVC
+// compilers. Do not include this file in a compilation unit that uses placement new. Include this file last after other
+// includes; e.g. Bullet's include files will cause a compile error if this file is included before them. Also note that
+// using DebugNew.h is by no means mandatory, but just a debugging convenience.
+
 #pragma once
 
 #if defined(_MSC_VER) && defined(_DEBUG)