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>

diff --git a/src/util/viralloc.h b/src/util/viralloc.h
index 518419e694aa5f2c7f3ebf35c8a89e489e3d7dd7..226d4d9b648367bf63ad227fd7832c1ca6323d5a 100644 (file)
--- a/src/util/viralloc.h
+++ b/src/util/viralloc.h
@@ -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) \