summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-13 12:04:32 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-11-13 12:04:32 +0900
commit3830cbaa25329b94252eccc7ac00449d023d5a6b (patch)
tree1908b8b2685d4088ac1a4b2d6964aaaa59f2374f /src
parentf40c91941d5992b4a12802c42e709cbd9861faa1 (diff)
eina: Improve eina_alloca API dox
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5461
Diffstat (limited to 'src')
-rw-r--r--src/lib/eina/eina_alloca.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/src/lib/eina/eina_alloca.h b/src/lib/eina/eina_alloca.h
index c0e1b10217..db6a3945a6 100644
--- a/src/lib/eina/eina_alloca.h
+++ b/src/lib/eina/eina_alloca.h
@@ -24,8 +24,8 @@
24 24
25/** 25/**
26 * @file eina_alloca.h 26 * @file eina_alloca.h
27 * simplifies usage of alloca() by including the proper file 27 * Check if GCC's alloca() is available. If it is available via a different spelling,
28 * depending on the platform. 28 * define alloca to that spelling.
29 */ 29 */
30 30
31# ifdef EINA_HAVE_ALLOCA_H 31# ifdef EINA_HAVE_ALLOCA_H
@@ -43,8 +43,13 @@
43extern "C" 43extern "C"
44# endif 44# endif
45/** 45/**
46 * Allocates memory in the stack frame of the caller, so it's automatically 46 * @brief Allocates memory in the stack frame of the caller, so that it
47 * freed when the caller returns. See alloca(3) for details. 47 * is automatically freed when the caller returns.
48 *
49 * @param size Number of bytes of space to allocate.
50 * @return Pointer to beginning of the allocated space.
51 *
52 * @see alloca(3) for more details.
48 */ 53 */
49void *alloca(size_t size); 54void *alloca(size_t size);
50# endif 55# endif