Changeset 5d1a94 for molecuilder/src/Helpers/MemDebug.hpp

Timestamp:

Apr 29, 2010, 2:38:29 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

16eb32

Parents:

0d111b

Message:

Improved comments for the memory tracker

File:

• molecuilder/src/Helpers/MemDebug.hpp (modified) (2 diffs)

molecuilder/src/Helpers/MemDebug.hpp

@@ -9 +9 @@
 #define MEMDEBUG_HPP_
 
+/**
+ * @file
+ * This module allows easy automatic memory tracking. Link this module to replace the
+ * operators new, new[], delete and delete[] with custom versions that add tracking
+ * information to allocated blocks.
+ *
+ * All tracking is done in O(1) for new and delete operators. Summaries for the
+ * used memory take O(N), where N is the number of currently allocated memory chunks.
+ *
+ * To use full tracking including file name and line number include this file in
+ * your sourcefiles.
+ */
+
 namespace Memory {
+
+  /**
+   * Displays a short summary of the memory state.
+   */
   void getState();
 
   void _ignore(void*);
 
+  /**
+   * Use this to disable memory for a certain pointer on the heap.
+   * This is useful for pointers which should live over the run of the
+   * program, and which are deleted automatically at the end. Usually these
+   * pointers should be wrapped inside some kind of smart pointer to
+   * ensure destruction at the end.
+   */
   template <typename T>
   T *ignore(T* ptr){
@@ -26 +50 @@
 void operator delete[] (void *ptr,const char*, int) throw();
 
-
+/**
+ * This macro replaces all occurences of the keyword new with a replaced
+ * version that allows tracking.
+ */
 #define new new(__FILE__,__LINE__)