Changeset 25059 in vbox for trunk/include/iprt

Timestamp:

Nov 27, 2009 6:17:44 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

55410

Message:

RTHeapOffset: Initial conversion of RTHeapSimple.

File:

• trunk/include/iprt/heap.h (modified) (4 diffs)

trunk/include/iprt/heap.h

@@ -261 +261 @@
  * Reallocates / Allocates / Frees a heap block.
  *
- * @param   hHeap       The heap, mandatory.
+ * @param   hHeap       The heap handle. This is optional and will only be used
+ *                      for strict assertions.
  * @param   pv          The heap block returned by RTHeapOffset. If NULL it
  *                      behaves like RTHeapOffsetAlloc().
@@ -275 +276 @@
  * Reallocates / Allocates / Frees a heap block, zeroing any new bits.
  *
- * @param   hHeap       The heap, mandatory.
+ * @param   hHeap       The heap handle. This is optional and will only be used
+ *                      for strict assertions.
  * @param   pv          The heap block returned by RTHeapOffset. If NULL it
  *                      behaves like RTHeapOffsetAllocZ().
@@ -289 +291 @@
  * Frees memory allocated from a simple heap.
  *
- * @param   hHeap       The heap handle, mandatory.
+ * @param   hHeap       The heap handle. This is optional and will only be used
+ *                      for strict assertions.
  * @param   pv          The heap block returned by RTHeapOffset
  */
@@ -301 +304 @@
  *          invalid \a pv can also cause traps or trigger assertions.
  *
- * @param   hHeap       The heap handle, mandatory.
+ * @param   hHeap       The heap handle. This is optional and will only be used
+ *                      for strict assertions.
  * @param   pv          The heap block returned by RTHeapOffset
  */