Cleanup: Abstruse documentation comments.

Ensure the details on what is and is not de-allocated is described in the documentation comments.
Also alphabetize this list.

diff --git a/level_0/f_abstruse/c/abstruse/abstruse.h b/level_0/f_abstruse/c/abstruse/abstruse.h
index 5ded85917ae83183e89c7f565711bd3c9e716ff7..a48bb7b84016d469aadb96d6af7ab7f18bc4c507 100644 (file)
--- a/level_0/f_abstruse/c/abstruse/abstruse.h
+++ b/level_0/f_abstruse/c/abstruse/abstruse.h
@@ -94,26 +94,26 @@ extern "C" {
  * Delete the f_abstruse_t structure.
  *
  * This only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -138,26 +138,26 @@ extern "C" {
  * Destroy the f_abstruse_t structure.
  *
  * This only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -182,26 +182,26 @@ extern "C" {
  * A callback intended to be passed to f_memory_arrays_resize() for an f_abstruses_t structure.
  *
  * This callback only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -236,26 +236,26 @@ extern "C" {
  * A callback intended to be passed to f_memory_arrays_adjust() for an f_abstruses_t structure.
  *
  * This callback only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -290,26 +290,26 @@ extern "C" {
  * A callback intended to be passed to f_memory_arrays_resize() for an f_abstrusess_t structure.
  *
  * This callback only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -344,26 +344,26 @@ extern "C" {
  * A callback intended to be passed to f_memory_arrays_adjust() for an f_abstrusess_t structure.
  *
  * This callback only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.

diff --git a/level_0/f_abstruse/c/abstruse/map.h b/level_0/f_abstruse/c/abstruse/map.h
index f2d8bf3330ef04c0f69f70d8874ba77c926af5e7..af923e2d537af597b241ee8c18f5c342db243f3a 100644 (file)
--- a/level_0/f_abstruse/c/abstruse/map.h
+++ b/level_0/f_abstruse/c/abstruse/map.h
@@ -86,26 +86,26 @@ extern "C" {
  * Delete the f_abstruse_map_t structure.
  *
  * This only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -130,26 +130,26 @@ extern "C" {
  * Destroy the f_abstruse_map_t structure.
  *
  * This only de-allocates the following:
- *   - a_u8s
- *   - a_u16s
- *   - a_u32s
- *   - a_u64s
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
  *   - a_i8s
  *   - a_i16s
  *   - a_i32s
  *   - a_i64s
- *   - a_signeds
- *   - a_unsigneds
- *   - a_static (as an f_string_dynamic_t, if size > 0).
- *   - a_statics (as an f_string_dynamics_t, if size > 0).
  *   - a_map
- *   - a_maps
  *   - a_map_multi
  *   - a_map_multis
+ *   - a_maps
  *   - a_quantitys
  *   - a_ranges
+ *   - a_signeds
  *   - a_triple
  *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
  *
  * For all other types, the caller must handle de-allocation to avoid memory leaks.
  * Provide and use a custom callback if special handling of deallocation is needed.
@@ -175,6 +175,28 @@ extern "C" {
  *
  * This is only called when shrinking the array and generally should perform deallocations.
  *
+ * This callback only de-allocates the following:
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
+ *   - a_i8s
+ *   - a_i16s
+ *   - a_i32s
+ *   - a_i64s
+ *   - a_map
+ *   - a_map_multi
+ *   - a_map_multis
+ *   - a_maps
+ *   - a_quantitys
+ *   - a_ranges
+ *   - a_signeds
+ *   - a_triple
+ *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
+ *
  * This does not do parameter checking.
  *
  * @param start
@@ -204,6 +226,28 @@ extern "C" {
  *
  * This is only called when shrinking the array and generally should perform deallocations.
  *
+ * This callback only de-allocates the following:
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
+ *   - a_i8s
+ *   - a_i16s
+ *   - a_i32s
+ *   - a_i64s
+ *   - a_map
+ *   - a_map_multi
+ *   - a_map_multis
+ *   - a_maps
+ *   - a_quantitys
+ *   - a_ranges
+ *   - a_signeds
+ *   - a_triple
+ *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
+ *
  * This does not do parameter checking.
  *
  * @param start
@@ -233,6 +277,28 @@ extern "C" {
  *
  * This is only called when shrinking the array and generally should perform deallocations.
  *
+ * This callback only de-allocates the following:
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
+ *   - a_i8s
+ *   - a_i16s
+ *   - a_i32s
+ *   - a_i64s
+ *   - a_map
+ *   - a_map_multi
+ *   - a_map_multis
+ *   - a_maps
+ *   - a_quantitys
+ *   - a_ranges
+ *   - a_signeds
+ *   - a_triple
+ *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
+ *
  * This does not do parameter checking.
  *
  * @param start
@@ -262,6 +328,28 @@ extern "C" {
  *
  * This is only called when shrinking the array and generally should perform deallocations.
  *
+ * This callback only de-allocates the following:
+ *   - a_dynamic (if size > 0)
+ *   - a_dynamics (if size > 0)
+ *   - a_i8s
+ *   - a_i16s
+ *   - a_i32s
+ *   - a_i64s
+ *   - a_map
+ *   - a_map_multi
+ *   - a_map_multis
+ *   - a_maps
+ *   - a_quantitys
+ *   - a_ranges
+ *   - a_signeds
+ *   - a_triple
+ *   - a_triples
+ *   - a_u8s
+ *   - a_u16s
+ *   - a_u32s
+ *   - a_u64s
+ *   - a_unsigneds
+ *
  * This does not do parameter checking.
  *
  * @param start