kernel: document behavior of k_free

Document that when passing NULL to k_free, nothing happens.

Jira: ZEP-1475
Change-Id: I0efab2c8c670b0cebfd3e72aa8cd64857798abea
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-12-20 08:36:04 -05:00 committed by Anas Nashif
commit 345fdd52b1

View file

@ -2915,6 +2915,8 @@ extern void *k_malloc(size_t size);
* This routine provides traditional free() semantics. The memory being
* returned must have been allocated from the heap memory pool.
*
* If @a ptr is NULL, no operation is performed.
*
* @param ptr Pointer to previously allocated memory.
*
* @return N/A