From 3c4c109de1c3369cd86cdd3ed20fc5884bd28d3b Mon Sep 17 00:00:00 2001
From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
Date: Fri, 6 Oct 2023 16:45:30 +0200
Subject: [PATCH] basic/macro: add comment explaining
 DEFINE_TRIVIAL_DESTRUCTOR()

---
 src/basic/macro.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/basic/macro.h b/src/basic/macro.h
index 0c99d68db26..7f650d0719e 100644
--- a/src/basic/macro.h
+++ b/src/basic/macro.h
@@ -310,6 +310,8 @@ static inline int __coverity_check_and_return__(int condition) {
 #define FOREACH_ARRAY(i, array, num)                                    \
         _FOREACH_ARRAY(i, array, num, UNIQ_T(m, UNIQ), UNIQ_T(end, UNIQ))
 
+/* A wrapper for 'func' to return void.
+ * Only useful when a void-returning function is required by some API. */
 #define DEFINE_TRIVIAL_DESTRUCTOR(name, type, func)             \
         static inline void name(type *p) {                      \
                 func(p);                                        \
-- 
2.47.3