# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1737659943 -3600
# Node ID 9437530176bc71912f8b7d3925eeb745d9b87b5b
# Parent  a06a2d27c043bc6e12abcd7e5befe01d83c62c6d
add symbols that need documentation as TODOs

relates to #451

diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/cfg/buildprofiles.xml
--- a/docs/Writerside/cfg/buildprofiles.xml	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/cfg/buildprofiles.xml	Thu Jan 23 20:19:03 2025 +0100
@@ -11,6 +11,7 @@
     </variables>
     <build-profile instance="ucx">
         <variables>
+            <offline-docs>true</offline-docs>
             <noindex-content>true</noindex-content>
         </variables>
     </build-profile>
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/allocator.h.md
--- a/docs/Writerside/topics/allocator.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/allocator.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -32,3 +32,16 @@
 }
 ```
 
+## Undocumented Symbols (TODO)
+
+### cxCalloc
+### cx_default_allocator
+### cxDefaultAllocator
+### cxFree
+### cxMalloc
+### cxRealloc
+### cxReallocArray
+### cx_reallocate_
+### cxReallocate_
+### cx_reallocatearray_
+### cxReallocateArray_
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/array_list.h.md
--- a/docs/Writerside/topics/array_list.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/array_list.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -39,3 +39,17 @@
 You can use `CX_ARRAY_DECLARE()` to declare the necessary fields within a structure and then use the
 `cx_array_simple_*()` convenience macros to reduce code overhead.
 The convenience macros automatically determine the width of the size/capacity variables.
+
+## Undocumented Symbols (TODO)
+### cx_array_binary_search
+### cx_array_binary_search_inf
+### cx_array_binary_search_sup
+### cx_array_copy
+### cx_array_default_reallocator
+### cx_array_default_reallocator_impl
+### cx_array_insert_sorted
+### cxArrayListCreate
+### cx_array_reallocator
+### cx_array_reserve
+### cx_array_swap
+### cx_array_swap_sbo_size
\ No newline at end of file
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/buffer.h.md
--- a/docs/Writerside/topics/buffer.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/buffer.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -10,3 +10,26 @@
 Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative
 to automatically resizing the buffer space.
 Please refer to the API doc for the fields prefixed with `flush_` to learn more. 
+
+## Undocumented Symbols (TODO)
+### cxBufferAppend
+### cxBufferClear
+### cxBufferCreate
+### cxBufferDestroy
+### cxBufferEnableFlushing
+### cxBufferEof
+### cxBufferFlush
+### cxBufferFree
+### cxBufferGet
+### cxBufferInit
+### cxBufferMinimumCapacity
+### cxBufferPut
+### cxBufferPutString
+### cxBufferRead
+### cxBufferReset
+### cxBufferSeek
+### cxBufferShift
+### cxBufferShiftLeft
+### cxBufferShiftRight
+### cxBufferTerminate
+### cxBufferWrite
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/compare.h.md
--- a/docs/Writerside/topics/compare.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/compare.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -2,3 +2,38 @@
 
 This header file contains a collection of compare functions for various data types.
 Their signatures are designed to be compatible with the `cx_compare_func` function pointer type.
+
+## Undocumented Symbols (TODO)
+### cx_cmp_double
+### cx_cmp_float
+### cx_cmp_int
+### cx_cmp_int16
+### cx_cmp_int32
+### cx_cmp_int64
+### cx_cmp_intptr
+### cx_cmp_longint
+### cx_cmp_longlong
+### cx_cmp_ptr
+### cx_cmp_uint
+### cx_cmp_uint16
+### cx_cmp_uint32
+### cx_cmp_uint64
+### cx_cmp_uintptr
+### cx_cmp_ulongint
+### cx_cmp_ulonglong
+### cx_vcmp_double
+### cx_vcmp_float
+### cx_vcmp_int
+### cx_vcmp_int16
+### cx_vcmp_int32
+### cx_vcmp_int64
+### cx_vcmp_intptr
+### cx_vcmp_longint
+### cx_vcmp_longlong
+### cx_vcmp_uint
+### cx_vcmp_uint16
+### cx_vcmp_uint32
+### cx_vcmp_uint64
+### cx_vcmp_uintptr
+### cx_vcmp_ulongint
+### cx_vcmp_ulonglong
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/hash_key.h.md
--- a/docs/Writerside/topics/hash_key.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/hash_key.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -1,1 +1,7 @@
 # hash_key.h
+
+## Undocumented Symbols (TODO)
+### cx_hash_key
+### cx_hash_key_bytes
+### cx_hash_key_str
+### cx_hash_murmur
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/hash_map.h.md
--- a/docs/Writerside/topics/hash_map.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/hash_map.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -6,3 +6,7 @@
 but you need to be careful, because when you use this function you are effectively locking into using this
 specific hash map implementation, and you would need to remove all calls to this function when you want to
 exchange the concrete map implementation with something different.
+
+## Undocumented Symbols (TODO)
+### cxHashMapCreate
+### cxMapRehash
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/iterator.h.md
--- a/docs/Writerside/topics/iterator.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/iterator.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -19,3 +19,9 @@
 On mutating iterators it is allowed to call the `cxFlagForRemoval()` function, which instructs the iterator to remove
 the current element from the collection on the next call to `cxIteratorNext()` and clear the flag afterward.
 If you are implementing your own iterator, it is up to you to implement this behavior.
+
+## Undocumented Symbols (TODO)
+### cxIterator
+### cxIteratorPtr
+### cxMutIterator
+### cxMutIteratorPtr
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/json.h.md
--- a/docs/Writerside/topics/json.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/json.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -1,1 +1,38 @@
 # json.h
+
+## Undocumented Symbols (TODO)
+### cxJsonArrAddCxStrings
+### cxJsonArrAddIntegers
+### cxJsonArrAddLiterals
+### cxJsonArrAddNumbers
+### cxJsonArrAddStrings
+### cxJsonArrAddValues
+### cxJsonArrGet
+### cxJsonArrIter
+### cxJsonCreateArr
+### cxJsonCreateCxString
+### cxJsonCreateInteger
+### cxJsonCreateLiteral
+### cxJsonCreateNumber
+### cxJsonCreateObj
+### cxJsonCreateString
+### cxJsonDestroy
+### cxJsonFilln
+### cxJsonInit
+### cxJsonNext
+### cx_json_obj_get_cxstr
+### cxJsonObjIter
+### cxJsonObjPut
+### cxJsonObjPutArr
+### cxJsonObjPutCxString
+### cxJsonObjPutInteger
+### cxJsonObjPutLiteral
+### cxJsonObjPutNumber
+### cxJsonObjPutObj
+### cxJsonObjPutString
+### cxJsonValueFree
+### cxJsonWrite
+### cxJsonWriterCompact
+### cx_json_write_rec
+### cxJsonWriterPretty
+
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/linked_list.h.md
--- a/docs/Writerside/topics/linked_list.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/linked_list.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -25,3 +25,25 @@
 
 cx_linked_list_at(&a, 0, loc_next, 2); // returns pointer to c
 ```
+
+## Undocumented Symbols (TODO)
+### cx_linked_list_add
+### cx_linked_list_at
+### cx_linked_list_compare
+### cxLinkedListCreate
+### cx_linked_list_find
+### cx_linked_list_find_node
+### cx_linked_list_first
+### cx_linked_list_insert
+### cx_linked_list_insert_chain
+### cx_linked_list_insert_sorted
+### cx_linked_list_insert_sorted_chain
+### cx_linked_list_last
+### cx_linked_list_link
+### cx_linked_list_prepend
+### cx_linked_list_prev
+### cx_linked_list_remove_chain
+### cx_linked_list_reverse
+### cx_linked_list_size
+### cx_linked_list_sort
+### cx_linked_list_unlink
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/list.h.md
--- a/docs/Writerside/topics/list.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/list.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -8,3 +8,17 @@
 It is strongly recommended that this class is shared among all instances of the same list type, because otherwise
 the `cxListCompare` function cannot use the optimized implementation of your class and will instead fall back to
 using iterators to compare the contents element-wise.
+
+## Undocumented Symbols (TODO)
+### cx_empty_list
+### cxEmptyList
+### cxListCompare
+### cx_list_default_insert_array
+### cx_list_default_insert_sorted
+### cx_list_default_sort
+### cx_list_default_swap
+### cxListFree
+### cx_list_init
+### cxListMutBackwardsIteratorAt
+### cxListMutIteratorAt
+
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/map.h.md
--- a/docs/Writerside/topics/map.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/map.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -20,3 +20,11 @@
 return the requested thing.
 There are no automatic checks to enforce this - it's completely up to you.
 If you need inspiration on how to do that, check the hash map implementation that comes with UCX.
+
+## Undocumented Symbols (TODO)
+### cx_empty_map
+### cxEmptyMap
+### cxMapFree
+### cxMapMutIterator
+### cxMapMutIteratorKeys
+### cxMapMutIteratorValues
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/mempool.h.md
--- a/docs/Writerside/topics/mempool.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/mempool.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -7,7 +7,7 @@
 allocated memory for you, which should be freed together with this pool.
 
 Many UCX features support the use of an allocator.
-The [strings](#string), for instance, provide several functions suffixed with `_a` that allow specifying an allocator.
+The [strings](string.h.md), for instance, provide several functions suffixed with `_a` that allow specifying an allocator.
 You can use this to keep track of the memory occupied by dynamically allocated strings and cleanup everything with
 just a single call to `cxMempoolFree()`.
 
@@ -88,3 +88,9 @@
 } 
 ```
 
+## Undocumented Symbols (TODO)
+### cxMempoolCreate
+### cxMempoolFree
+### cxMempoolRegister
+### cxMempoolRemoveDestructor
+### cxMempoolSetDestructor
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/printf.h.md
--- a/docs/Writerside/topics/printf.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/printf.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -5,3 +5,14 @@
 With the help of these convenience functions, you do not need to `snprintf` your string to a temporary buffer anymore,
 plus you do not need to worry about too small buffer sizes, because the functions will automatically allocate enough
 memory to contain the entire formatted string.
+
+## Undocumented Symbols (TODO)
+### cx_asprintf_a
+### cx_fprintf
+### cx_printf_sbo_size
+### cx_sprintf_a
+### cx_sprintf_sa
+### cx_vasprintf_a
+### cx_vfprintf
+### cx_vsprintf_a
+### cx_vsprintf_sa
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/properties.h.md
--- a/docs/Writerside/topics/properties.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/properties.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -1,1 +1,15 @@
 # properties.h
+
+## Undocumented Symbols (TODO)
+### cx_properties_config_default
+### cxPropertiesCstrnSource
+### cxPropertiesCstrSource
+### cxPropertiesDestroy
+### cxPropertiesFileSource
+### cxPropertiesFilln
+### cxPropertiesInit
+### cxPropertiesLoad
+### cxPropertiesMapSink
+### cxPropertiesNext
+### cxPropertiesStringSource
+### cxPropertiesUseStack
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/streams.h.md
--- a/docs/Writerside/topics/streams.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/streams.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -28,3 +28,7 @@
     }
 }
 ```
+
+## Undocumented Symbols (TODO)
+### cx_stream_bncopy
+### cx_stream_ncopy
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/string.h.md
--- a/docs/Writerside/topics/string.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/string.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -14,3 +14,66 @@
 string, it is explicitly mentioned in the documentation of the respective function.
 As a rule of thumb, you _should not_ pass the strings of a UCX string structure to another API without explicitly
 ensuring that the string is zero-terminated.
+
+## Undocumented Symbols (TODO)
+### cx_mutstr
+### cx_mutstrn
+### cx_str
+### cx_strcasecmp
+### cx_strcasecmp_p
+### cx_strcaseprefix
+### cx_strcasesuffix
+### cx_strcat_ma
+### cx_strchr
+### cx_strchr_m
+### cx_strcmp
+### cx_strcmp_p
+### cx_strdup_a_
+### cx_strfree
+### cx_strfree_a
+### cx_strlen
+### cx_strlower
+### cx_strn
+### cx_strprefix
+### cx_strrchr
+### cx_strrchr_m
+### cx_strreplacen_a
+### cx_strsplit
+### cx_strsplit_a
+### cx_strsplit_m
+### cx_strsplit_ma
+### cx_strstr
+### cx_strstr_m
+### cx_strstr_sbo_size
+### cx_strsubs
+### cx_strsubsl
+### cx_strsubsl_m
+### cx_strsubs_m
+### cx_strsuffix
+### cx_strtod_lc_
+### cx_strtof_lc_
+### cx_strtoi16_lc_
+### cx_strtoi32_lc_
+### cx_strtoi64_lc_
+### cx_strtoi8_lc_
+### cx_strtoi_lc_
+### cx_strtok_
+### cx_strtok_delim
+### cx_strtok_next
+### cx_strtok_next_m
+### cx_strtol_lc_
+### cx_strtoll_lc_
+### cx_strtos_lc_
+### cx_strtou16_lc_
+### cx_strtou32_lc_
+### cx_strtou64_lc_
+### cx_strtou8_lc_
+### cx_strtou_lc_
+### cx_strtoul_lc_
+### cx_strtoull_lc_
+### cx_strtous_lc_
+### cx_strtouz_lc_
+### cx_strtoz_lc_
+### cx_strtrim
+### cx_strtrim_m
+### cx_strupper
diff -r a06a2d27c043 -r 9437530176bc docs/Writerside/topics/tree.h.md
--- a/docs/Writerside/topics/tree.h.md	Thu Jan 23 01:33:36 2025 +0100
+++ b/docs/Writerside/topics/tree.h.md	Thu Jan 23 20:19:03 2025 +0100
@@ -1,1 +1,27 @@
 # tree.h
+
+## Undocumented Symbols (TODO)
+
+### cx_tree_add
+### cx_tree_add_array
+### cxTreeAddChild
+### cxTreeAddChildNode
+### cx_tree_add_iter
+### cx_tree_add_look_around_depth
+### cxTreeCreate
+### cxTreeCreateWrapped
+### cxTreeDepth
+### cxTreeDestroyNode
+### cxTreeDestroySubtree
+### cxTreeFree
+### cx_tree_iterator
+### cx_tree_link
+### cxTreeRemoveNode
+### cxTreeRemoveSubtree
+### cx_tree_search
+### cx_tree_search_data
+### cxTreeSetParent
+### cxTreeSubtreeDepth
+### cxTreeSubtreeSize
+### cx_tree_unlink
+### cx_tree_visitor