Mercurial > hg > ucx / changeset

--- a/docs/Writerside/topics/array_list.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/array_list.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # Array List
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 Since low-level array lists are just plain arrays, there is no need for such many low-level functions as for linked
@@ -44,6 +44,7 @@
 `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
@@ -56,4 +57,10 @@
 ### cx_array_reallocator
 ### cx_array_reserve
 ### cx_array_swap
-### cx_array_swap_sbo_size
\ No newline at end of file
+### cx_array_swap_sbo_size
+-->
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/array__list_8h.html">array_list.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/buffer.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/buffer.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,12 +1,12 @@
 # Buffer
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream.
 This allows the use of `cx_stream_copy()` (see [](streams.h.md)) to copy contents from one buffer to another,
-or from a file or network streams to the buffer and vice-versa.
+or from a file or network streams to the buffer and vice versa.
 
 More features for convenient use of the buffer can be enabled, like automatic memory management and automatic
 resizing of the buffer space.
@@ -15,6 +15,7 @@
 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
@@ -37,3 +38,10 @@
 ### cxBufferShiftRight
 ### cxBufferTerminate
 ### cxBufferWrite
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/buffer_8h.html">buffer.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/hash_map.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/hash_map.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # Hash Map
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 UCX provides a basic hash map implementation with a configurable amount of buckets.
@@ -11,6 +11,15 @@
 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
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/hash__map_8h.html">hash_map.h</a>
+</category>
+</seealso>
+

--- a/docs/Writerside/topics/install.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/install.md	Tue Feb 11 20:10:29 2025 +0100
@@ -113,7 +113,7 @@
 </tr>
 <tr>
     <td>CX_ARRAY_SWAP_SBO_SIZE</td>
-    <td>The maximum item size in an array list that uses SBO.</td>
+    <td>The maximum size of an element in an array list that can be swapped without allocating heap memory.</td>
     <td>128</td>
 </tr>
 <tr>

--- a/docs/Writerside/topics/iterator.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/iterator.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # Iterators
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 In UCX 3 a new feature has been introduced to write own iterators, that work with the `cx_foreach` macro.
@@ -24,8 +24,16 @@
 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
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/iterator_8h.html">iterator.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/json.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/json.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,5 +1,10 @@
 # JSON
 
+<warning>
+New Feature - will be documented soon!
+</warning>
+
+<!--
 ## Undocumented Symbols (TODO)
 ### cxJsonArrAddCxStrings
 ### cxJsonArrAddIntegers
@@ -35,4 +40,9 @@
 ### cxJsonWriterCompact
 ### cx_json_write_rec
 ### cxJsonWriterPretty
-
+-->
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/json_8h.html">json.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/linked_list.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/linked_list.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # Linked List
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 On top of implementing the list interface, this header also defines several low-level functions that
@@ -30,6 +30,7 @@
 cx_linked_list_at(&a, 0, loc_next, 2); // returns pointer to c
 ```
 
+<!--
 ## Undocumented Symbols (TODO)
 ### cx_linked_list_add
 ### cx_linked_list_at
@@ -51,3 +52,10 @@
 ### cx_linked_list_size
 ### cx_linked_list_sort
 ### cx_linked_list_unlink
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/linked__list_8h.html">linked_list.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/list.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/list.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # List Interface
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 This header defines a common interface for all list implementations.
@@ -13,6 +13,7 @@
 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
@@ -25,4 +26,10 @@
 ### cx_list_init
 ### cxListMutBackwardsIteratorAt
 ### cxListMutIteratorAt
+-->
 
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/list_8h.html">list.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/map.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/map.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # Map Interface
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 Similar to the list interface, the map interface provides a common API for implementing maps.
@@ -25,6 +25,7 @@
 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
@@ -32,3 +33,11 @@
 ### cxMapMutIterator
 ### cxMapMutIteratorKeys
 ### cxMapMutIteratorValues
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/map_8h.html">map.h</a>
+</category>
+</seealso>
+

--- a/docs/Writerside/topics/properties.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/properties.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,5 +1,10 @@
 # Properties
 
+<warning>
+New Feature - will be documented soon!
+</warning>
+
+<!--
 ## Undocumented Symbols (TODO)
 ### cx_properties_config_default
 ### cxPropertiesCstrnSource
@@ -13,3 +18,10 @@
 ### cxPropertiesNext
 ### cxPropertiesStringSource
 ### cxPropertiesUseStack
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/properties_8h.html">properties.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/string.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/string.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,7 +1,7 @@
 # String
 
 <warning>
-Outdated - Rewrite!
+Outdated Section - will be updated soon!
 </warning>
 
 UCX strings come in two variants: immutable (`cxstring`) and mutable (`cxmutstr`).
@@ -19,6 +19,7 @@
 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.
 
+<!--
 ## Basics
 
 ### cx_mutstr
@@ -104,3 +105,10 @@
 ### cx_strtous_lc
 ### cx_strtouz_lc
 ### cx_strtoz_lc
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/string_8h.html">string.h</a>
+</category>
+</seealso>

--- a/docs/Writerside/topics/tree.h.md	Tue Feb 11 19:55:32 2025 +0100
+++ b/docs/Writerside/topics/tree.h.md	Tue Feb 11 20:10:29 2025 +0100
@@ -1,5 +1,10 @@
 # Tree
 
+<warning>
+New Feature - will be documented soon!
+</warning>
+
+<!--
 ## Undocumented Symbols (TODO)
 
 ### cx_tree_add
@@ -25,3 +30,11 @@
 ### cxTreeSubtreeSize
 ### cx_tree_unlink
 ### cx_tree_visitor
+-->
+
+<seealso>
+<category ref="apidoc">
+<a href="https://ucx.sourceforge.io/api/tree_8h.html">tree.h</a>
+</category>
+</seealso>
+