Document wmem null guarantee

Change-Id: Ibbbda815b144441f7db2d1920e1551c45e997370
Reviewed-on: https://code.wireshark.org/review/15549
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Dario Lombardo <lomato@gmail.com>
This commit is contained in:
Evan Huus 2016-05-23 22:12:19 -04:00 committed by Dario Lombardo
parent 6d9022d19f
commit 3ace225e0d
1 changed files with 4 additions and 0 deletions

View File

@ -40,6 +40,10 @@ extern "C" {
* many other functions are available (see the "Modules" list at the top of
* the generated doxygen HTML).
*
* Any wmem functions which allocate memory are guaranteed to either succeed or
* abort the program. However, they *can* still legally return NULL when the
* amount of requested memory is zero.
*
* @{
*/