Commit 59c5e16d authored by Mukund Sivaraman's avatar Mukund Sivaraman
Browse files

[2088] Add comments about size argument to deallocate()

parent 25cc38bb
......@@ -44,7 +44,11 @@ public:
/// \brief Free/release a segment of memory.
///
/// This method may throw <code>isc::OutOfRange</code> if \c size is
/// not equal to the originally allocated size.
/// not equal to the originally allocated size. \c size could be
/// used by some implementations such as a slice allocator, where
/// freeing memory also requires the size to be specified. We also
/// use this argument in some implementations to test if all allocated
/// memory was deallocated properly.
///
/// \param ptr Pointer to the block of memory to free/release. This
/// should be equal to a value returned by <code>allocate()</code>.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment