add missing docs for cx_invoke_destructor()

Tue, 20 Jun 2023 18:28:47 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 20 Jun 2023 18:28:47 +0200
changeset 712
cff828e156a9
parent 711
71b2f3f63182
child 713
724e42ba6114

add missing docs for cx_invoke_destructor()

src/cx/collection.h file | annotate | diff | comparison | revisions
     1.1 --- a/src/cx/collection.h	Tue Jun 20 18:26:35 2023 +0200
     1.2 +++ b/src/cx/collection.h	Tue Jun 20 18:28:47 2023 +0200
     1.3 @@ -127,6 +127,15 @@
     1.4      (c)->store_pointer ? (*((void **) (e))) : (e))
     1.5  
     1.6  
     1.7 +/**
     1.8 + * Invokes all available destructor functions for a specific element.
     1.9 + *
    1.10 + * Usually only used by collection implementations. There should be no need
    1.11 + * to invoke this macro manually.
    1.12 + *
    1.13 + * @param c the collection
    1.14 + * @param e the element
    1.15 + */
    1.16  #define cx_invoke_destructor(c, e) \
    1.17      if ((c)->simple_destructor) cx_invoke_simple_destructor(c,e); \
    1.18      if ((c)->advanced_destructor) cx_invoke_advanced_destructor(c,e)

mercurial