Mercurial > hg > ucx / changeset

--- a/src/cx/collection.h	Tue Jun 20 18:26:35 2023 +0200
+++ b/src/cx/collection.h	Tue Jun 20 18:28:47 2023 +0200
@@ -127,6 +127,15 @@
     (c)->store_pointer ? (*((void **) (e))) : (e))
 
 
+/**
+ * Invokes all available destructor functions for a specific element.
+ *
+ * Usually only used by collection implementations. There should be no need
+ * to invoke this macro manually.
+ *
+ * @param c the collection
+ * @param e the element
+ */
 #define cx_invoke_destructor(c, e) \
     if ((c)->simple_destructor) cx_invoke_simple_destructor(c,e); \
     if ((c)->advanced_destructor) cx_invoke_advanced_destructor(c,e)