Mercurial > hg > ucx / changeset

--- a/docs/Writerside/topics/allocator.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/allocator.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Allocator
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 The UCX allocator provides an interface for implementing an own memory allocation mechanism.
 Various function in UCX provide an additional alternative signature that takes an allocator as
 argument. A default allocator implementation using the stdlib memory management functions is

--- a/docs/Writerside/topics/array_list.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/array_list.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Array List
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 Since low-level array lists are just plain arrays, there is no need for such many low-level functions as for linked
 lists.
 However, there is one extremely powerful function that can be used for several complex tasks: `cx_array_copy`.

--- a/docs/Writerside/topics/buffer.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/buffer.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,7 +1,11 @@
 # Buffer
 
+<warning>
+Outdated - Rewrite!
+</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 [Utilities](#utilities)) to copy contents from one buffer to another,
+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.
 
 More features for convenient use of the buffer can be enabled, like automatic memory management and automatic

--- a/docs/Writerside/topics/collection.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/collection.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Collections
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 Collections in UCX 3 have several common features.
 If you want to implement an own collection data type that uses the same features, you can use the
 `CX_COLLECTION_BASE` macro at the beginning of your struct to roll out all members a usual UCX collection has.

--- a/docs/Writerside/topics/compare.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/compare.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Compare Functions
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 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.
 

--- a/docs/Writerside/topics/hash_map.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/hash_map.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Hash Map
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 UCX provides a basic hash map implementation with a configurable amount of buckets.
 If you do not specify the number of buckets, a default of 16 buckets will be used.
 You can always rehash the map with `cxMapRehash()` to change the number of buckets to something more efficient,

--- a/docs/Writerside/topics/iterator.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/iterator.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Iterators
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 In UCX 3 a new feature has been introduced to write own iterators, that work with the `cx_foreach` macro.
 In previous UCX releases there were different hard-coded foreach macros for lists and maps that were not customizable.
 Now, creating an iterator is as simple as creating a `CxIterator` struct and setting the fields in a meaningful way.

--- a/docs/Writerside/topics/linked_list.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/linked_list.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Linked List
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 On top of implementing the list interface, this header also defines several low-level functions that
 work with arbitrary structures.
 Low-level functions, in contrast to the high-level list interface, can easily be recognized by their snake-casing.

--- a/docs/Writerside/topics/list.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/list.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # List Interface
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 This header defines a common interface for all list implementations.
 
 UCX already comes with two common list implementations (linked list and array list) that should cover most use cases.

--- a/docs/Writerside/topics/map.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/map.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Map Interface
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 Similar to the list interface, the map interface provides a common API for implementing maps.
 There are some minor subtle differences, though.
 

--- a/docs/Writerside/topics/mempool.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/mempool.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Memory Pool
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 A memory pool is providing an allocator implementation that automatically deallocates the memory upon its destruction.
 It also allows you to register destructor functions for the allocated memory, which are automatically called before
 the memory is deallocated.

--- a/docs/Writerside/topics/printf.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/printf.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # Formatting
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 In this utility header you can find `printf()`-like functions that can write the formatted output to an arbitrary
 stream (or UCX buffer, resp.), or to memory allocated by an allocator within a single function call.
 With the help of these convenience functions, you do not need to `snprintf` your string to a temporary buffer anymore,

--- a/docs/Writerside/topics/string.h.md	Sat Jan 25 13:40:50 2025 +0100
+++ b/docs/Writerside/topics/string.h.md	Sat Jan 25 13:44:24 2025 +0100
@@ -1,5 +1,9 @@
 # String
 
+<warning>
+Outdated - Rewrite!
+</warning>
+
 UCX strings come in two variants: immutable (`cxstring`) and mutable (`cxmutstr`).
 The functions of UCX are designed to work with immutable strings by default but in situations where it is necessary,
 the API also provides alternative functions that work directly with mutable strings.