util: alloc: Clarify docs for VIR_DEFINE_AUTOCLEAN_FUNC

Document that @func must take pointer to @type.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2019-02-26 17:46:57 +01:00
parent 0278c77da8
commit 786f47414d

View File

@ -623,8 +623,8 @@ void virAllocTestHook(void (*func)(int, void*), void *data);
* @func: cleanup function to be automatically called
*
* This macro defines a function for automatic clearing of
* resources in a stack'd variable of type @type. This newly
* defined function works as a necessary wrapper around @func.
* resources in a stack'd variable of type @type. Note that @func must
* take pointer to @type.
*/
# define VIR_DEFINE_AUTOCLEAN_FUNC(type, func) \
static inline void VIR_AUTOCLEAN_FUNC_NAME(type)(type *_ptr) \