[PATCH 3/5] util: alloc: Clarify docs for VIR_DEFINE_AUTOCLEAN_FUNC

[Peter Krempa <pkrempa@xxxxxxxxxx>]

Document that @func must take pointer to @type.

Signed-off-by: Peter Krempa <pkrempa@xxxxxxxxxx>
---
 src/util/viralloc.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/util/viralloc.h b/src/util/viralloc.h
index 15451d4673..cecabc246c 100644
--- 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) \
-- 
2.20.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list