From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Fri, 6 Oct 2023 14:45:30 +0000 (+0200)
Subject: basic/macro: add comment explaining DEFINE_TRIVIAL_DESTRUCTOR()
X-Git-Tag: v255-rc1~302^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F29475%2Fhead;p=thirdparty%2Fsystemd.git

basic/macro: add comment explaining DEFINE_TRIVIAL_DESTRUCTOR()
---

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);                                        \