Added destructor comment and value_clone docs.

11 files changed, 21 insertions, 13 deletions

diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 81ad703c..044b7313 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -45,7 +45,7 @@ void                cdeq_X_reserve(cdeq_X* self, size_t cap);
 void                cdeq_X_resize(cdeq_X* self, size_t size, Value fill);
 void                cdeq_X_swap(cdeq_X* a, cdeq_X* b);
 
-void                cdeq_X_del(cdeq_X* self);
+void                cdeq_X_del(cdeq_X* self);      // destructor
 
 bool                cdeq_X_empty(cdeq_X deq);
 size_t              cdeq_X_size(cdeq_X deq);
diff --git a/docs/clist_api.md b/docs/clist_api.md
index a9550fe7..af71ae19 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -45,7 +45,7 @@ clist_X             clist_X_init(void);
 clist_X             clist_X_clone(clist_X list);
 
 void                clist_X_clear(clist_X* self);
-void                clist_X_del(clist_X* self);
+void                clist_X_del(clist_X* self);      // destructor
 
 bool                clist_X_empty(clist_X list);
 size_t              clist_X_size(clist_X list); // note: O(n)
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 26724bfd..9b0648b9 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -52,7 +52,7 @@ void                cmap_X_clear(cmap_X* self);
 void                cmap_X_reserve(cmap_X* self, size_t size);
 void                cmap_X_swap(cmap_X* a, cmap_X* b);
 
-void                cmap_X_del(cmap_X* self);
+void                cmap_X_del(cmap_X* self);                                                // destructor
 
 bool                cmap_X_empty(cmap_X map);
 size_t              cmap_X_size(cmap_X map);
@@ -78,6 +78,8 @@ cmap_X_iter_t       cmap_X_begin(cmap_X* self);
 cmap_X_iter_t       cmap_X_end(cmap_X* self);
 void                cmap_X_next(cmap_X_iter_t* it);
 cmap_X_mapped_t*    cmap_X_itval(cmap_X_iter_t it);
+
+cmap_X_value_t      cmap_X_value_clone(cmap_X_value_t val);
 ```
 ```c
 uint64_t            c_default_hash(const void *data, size_t len);       // bytewise hash
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 8d79c627..a4dd4669 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -32,7 +32,7 @@ All cpque definitions and prototypes may be included in your C source file by in
 cpque_X                 cpque_X_init(void);
 cpque_X                 cpque_X_clone(cpque_X pq);
 void                    cpque_X_make_heap(cpque_X* self);
-void                    cpque_X_del(cpque_X* self);
+void                    cpque_X_del(cpque_X* self);      // destructor
 
 size_t                  cpque_X_size(cpque_X pq);
 bool                    cpque_X_empty(cpque_X pq);
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 678dfb6b..66c5797b 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -38,7 +38,7 @@ The *del()* and *compare()* methods are defined based on the arguments passed to
 cptr_X              cptr_X_init(void);
 cptr_X              cptr_X_clone(cptr_X ptr);
 void                cptr_X_reset(cptr_X* self, cptr_X_value_t* ptr);
-void                cptr_X_del(cptr_X* self);
+void                cptr_X_del(cptr_X* self);         // destructor
 int                 cptr_X_compare(cptr_X* x, cptr_X* y);
 ```
 ### Shared pointer
@@ -46,8 +46,8 @@ int                 cptr_X_compare(cptr_X* x, cptr_X* y);
 csptr_X             csptr_X_from(csptr_X_value_t* ptr);
 csptr_X             csptr_X_make(csptr_X_value_t val);
 void                csptr_X_reset(csptr_X* self, csptr_X_value_t* ptr);
-csptr_X             csptr_X_clone(csptr_X sptr);    // share the pointer (increase use count)
-void                csptr_X_del(csptr_X* self);     // decrease use count, destroy if 0
+csptr_X             csptr_X_clone(csptr_X sptr);      // share the pointer (increase use count)
+void                csptr_X_del(csptr_X* self);       // destructor: decrease use count, destroy if 0
 int                 csptr_X_compare(csptr_X* x, csptr_X* y);
 ```
 
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 40a0796f..6a9aee7f 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -27,7 +27,7 @@ All cqueue definitions and prototypes may be included in your C source file by i
 ```c
 cqueue_X                cqueue_X_init(void);
 cqueue_X                cqueue_X_clone(cqueue_X q);
-void                    cqueue_X_del(cqueue_X* self);
+void                    cqueue_X_del(cqueue_X* self);      // destructor
 
 size_t                  cqueue_X_size(cqueue_X q);
 bool                    cqueue_X_empty(cqueue_X q);
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 6f40ea95..65061f8f 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -38,7 +38,7 @@ void                cset_X_clear(cset_X* self);
 void                cset_X_reserve(cset_X* self, size_t size);

 void                cset_X_swap(cset_X* a, cset_X* b);

 

-void                cset_X_del(cset_X* self);

+void                cset_X_del(cset_X* self);      // destructor

 

 bool                cset_X_empty(cset_X set);

 size_t              cset_X_size(cset_X set);

@@ -59,6 +59,8 @@ cset_X_iter_t       cset_X_begin(cset_X* self);
 cset_X_iter_t       cset_X_end(cset_X* self);

 void                cset_X_next(cset_X_iter_t* it);

 cset_X_value_t*     cset_X_itval(cset_X_iter_t it);

+

+cset_X_value_t      cset_X_value_clone(cset_X_value_t val);

 ```

 

 ## Types

diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 48059077..91562b9a 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -46,7 +46,7 @@ csmap_X             csmap_X_init(void);
 csmap_X             csmap_X_clone(csmap_x map);
 void                csmap_X_clear(csmap_X* self);
 void                csmap_X_swap(csmap_X* a, csmap_X* b);
-void                csmap_X_del(csmap_X* self);
+void                csmap_X_del(csmap_X* self);      // destructor
 
 bool                csmap_X_empty(csmap_X map);
 size_t              csmap_X_size(csmap_X map);
@@ -71,6 +71,8 @@ csmap_X_iter_t      csmap_X_begin(csmap_X* self);
 csmap_X_iter_t      csmap_X_end(csmap_X* self);
 void                csmap_X_next(csmap_X_iter_t* it);
 csmap_X_mapped_t*   csmap_X_itval(csmap_X_iter_t it);
+
+csmap_X_value_t     csmap_X_value_clone(csmap_X_value_t val);
 ```
 ## Types
 
diff --git a/docs/csset_api.md b/docs/csset_api.md
index e2edda7d..b6c2acf2 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -34,7 +34,7 @@ csset_X             csset_X_init(void);
 csset_X             csset_X_clone(csset_x set);

 void                csset_X_clear(csset_X* self);

 void                csset_X_swap(csset_X* a, csset_X* b);

-void                csset_X_del(csset_X* self);

+void                csset_X_del(csset_X* self);      // destructor

 

 bool                csset_X_empty(csset_X m);

 size_t              csset_X_size(csset_X m);

@@ -54,6 +54,8 @@ csset_X_iter_t      csset_X_begin(csset_X* self);
 csset_X_iter_t      csset_X_end(csset_X* self);

 void                csset_X_next(csset_X_iter_t* it);

 csset_X_value_t*    csset_X_itval(csset_X_iter_t it);

+

+csset_X_value_t     csset_X_value_clone(csset_X_value_t val);

 ```

 

 ## Types

diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 34d03c8e..4a8a6f34 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -28,7 +28,7 @@ All cstack definitions and prototypes may be included in your C source file by i
 ```c
 cstack_X                cstack_X_init(void);
 cstack_X                cstack_X_clone(cstack_X st);
-void                    cstack_X_del(cstack_X* self);
+void                    cstack_X_del(cstack_X* self);      // destructor
 
 size_t                  cstack_X_size(cstack_X st);
 bool                    cstack_X_empty(cstack_X st);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 07d18e68..09e73931 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -49,7 +49,7 @@ void                cvec_X_reserve(cvec_X* self, size_t cap);
 void                cvec_X_resize(cvec_X* self, size_t size, Value fill);
 void                cvec_X_swap(cvec_X* a, cvec_X* b);
 
-void                cvec_X_del(cvec_X* self);
+void                cvec_X_del(cvec_X* self);      // destructor
 
 bool                cvec_X_empty(cvec_X vec);
 size_t              cvec_X_size(cvec_X vec);