eina: Improve eina_alloca API dox

Reviewers: cedric, ajwillia.ms

Subscribers: segfaultxavi, jpeg

Differential Revision: https://phab.enlightenment.org/D5461
This commit is contained in:
Bryce Harrington 2017-11-13 12:04:32 +09:00 committed by Jean-Philippe Andre
parent f40c91941d
commit 3830cbaa25
1 changed files with 9 additions and 4 deletions

View File

@ -24,8 +24,8 @@
/**
* @file eina_alloca.h
* simplifies usage of alloca() by including the proper file
* depending on the platform.
* Check if GCC's alloca() is available. If it is available via a different spelling,
* define alloca to that spelling.
*/
# ifdef EINA_HAVE_ALLOCA_H
@ -43,8 +43,13 @@
extern "C"
# endif
/**
* Allocates memory in the stack frame of the caller, so it's automatically
* freed when the caller returns. See alloca(3) for details.
* @brief Allocates memory in the stack frame of the caller, so that it
* is automatically freed when the caller returns.
*
* @param size Number of bytes of space to allocate.
* @return Pointer to beginning of the allocated space.
*
* @see alloca(3) for more details.
*/
void *alloca(size_t size);
# endif