Adding Tilghman's documentation from asterisk-dev to the actual file.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@239389 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/include/asterisk/astmm.h b/include/asterisk/astmm.h
index 26273c938908b18c0f97b35ebfa6c1204b7865df..cf12f252a2e6ff73dd977d0123d8f0b45ee29a3f 100644 (file)
--- a/include/asterisk/astmm.h
+++ b/include/asterisk/astmm.h
@@ -18,6 +18,9 @@
 
 /*! \file
  * \brief Asterisk memory usage debugging
+ * This file provides headers for MALLOC_DEBUG, a define used for tracking down
+ * memory leaks.  It should never be #included directly; always use the
+ * MALLOC_DEBUG definition in menuselect to activate those functions.
  */