Mercurial > hg > ucx / changeset

--- a/docs/Writerside/topics/allocator.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/allocator.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# allocator.h
+# Allocator
 
 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

--- a/docs/Writerside/topics/array_list.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/array_list.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# array_list.h
+# Array List
 
 Since low-level array lists are just plain arrays, there is no need for such many low-level functions as for linked
 lists.

--- a/docs/Writerside/topics/buffer.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/buffer.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# buffer.h
+# Buffer
 
 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,

--- a/docs/Writerside/topics/collection.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/collection.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# collection.h
+# Collections
 
 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

--- a/docs/Writerside/topics/compare.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/compare.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# compare.h
+# Compare Functions
 
 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_key.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/hash_key.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# hash_key.h
+# Hash Function
 
 ## Undocumented Symbols (TODO)
 ### cx_hash_key

--- a/docs/Writerside/topics/hash_map.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/hash_map.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# hash_map.h
+# Hash Map
 
 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.

--- a/docs/Writerside/topics/iterator.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/iterator.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# iterator.h
+# Iterators
 
 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.

--- a/docs/Writerside/topics/json.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/json.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# json.h
+# JSON
 
 ## Undocumented Symbols (TODO)
 ### cxJsonArrAddCxStrings

--- a/docs/Writerside/topics/linked_list.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/linked_list.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# linked_list.h
+# Linked List
 
 On top of implementing the list interface, this header also defines several low-level functions that
 work with arbitrary structures.

--- a/docs/Writerside/topics/list.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/list.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# list.h
+# List Interface
 
 This header defines a common interface for all list implementations.
 

--- a/docs/Writerside/topics/map.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/map.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# map.h
+# Map Interface
 
 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	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/mempool.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# mempool.h
+# Memory Pool
 
 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

--- a/docs/Writerside/topics/printf.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/printf.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# printf.h
+# Formatting
 
 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.

--- a/docs/Writerside/topics/properties.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/properties.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# properties.h
+# Properties
 
 ## Undocumented Symbols (TODO)
 ### cx_properties_config_default

--- a/docs/Writerside/topics/streams.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/streams.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# streams.h
+# Stream Operations
 
 UCX provides some utilities for routine tasks.
 

--- a/docs/Writerside/topics/string.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/string.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# string.h
+# String
 
 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,

--- a/docs/Writerside/topics/test.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/test.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,1 +1,1 @@
-# test.h
+# Test Framework

--- a/docs/Writerside/topics/tree.h.md	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/topics/tree.h.md	Fri Jan 24 21:12:09 2025 +0100
@@ -1,4 +1,4 @@
-# tree.h
+# Tree
 
 ## Undocumented Symbols (TODO)
 

--- a/docs/Writerside/ucx.tree	Thu Jan 23 20:19:03 2025 +0100
+++ b/docs/Writerside/ucx.tree	Fri Jan 24 21:12:09 2025 +0100
@@ -8,13 +8,12 @@
     <toc-element topic="about.md"/>
     <toc-element topic="features.md">
         <toc-element topic="collections.md">
+            <toc-element topic="iterator.h.md"/>
             <toc-element topic="collection.h.md"/>
-            <toc-element topic="iterator.h.md"/>
             <toc-element topic="list.h.md"/>
             <toc-element topic="array_list.h.md"/>
             <toc-element topic="linked_list.h.md"/>
             <toc-element topic="map.h.md"/>
-            <toc-element topic="hash_key.h.md"/>
             <toc-element topic="hash_map.h.md"/>
             <toc-element topic="tree.h.md"/>
         </toc-element>
@@ -33,6 +32,7 @@
         </toc-element>
         <toc-element topic="utils.md">
             <toc-element topic="compare.h.md"/>
+            <toc-element topic="hash_key.h.md"/>
             <toc-element topic="streams.h.md"/>
             <toc-element topic="test.h.md"/>
         </toc-element>