Wed, 02 May 2018 18:47:22 +0200
removes artificial anchors from modules.md
docs/src/modules.md | file | annotate | diff | comparison | revisions |
--- a/docs/src/modules.md Wed May 02 18:42:04 2018 +0200 +++ b/docs/src/modules.md Wed May 02 18:47:22 2018 +0200 @@ -15,16 +15,14 @@ <div id="modules" align="center"> ------------------------ ---------------------- ---------------------------- ------------------------- -[Allocator](#allocator) [AVL Tree](#avl) [Buffer](#buffer) [List](#list) -[Logging](#logging) [Map](#map) [Memory Pool](#mempool) [Properties](#properties) -[Stack](#stack) [String](#string) [Testing](#test) [Utilities](#utils) ------------------------ ---------------------- ---------------------------- ------------------------- +----------------------- ---------------------- ---------------------------- ------------------------- +[Allocator](#allocator) [AVL Tree](#avl-tree) [Buffer](#buffer) [List](#list) +[Logging](#logging) [Map](#map) [Memory Pool](#memory-pool) [Properties](#properties) +[Stack](#stack) [String](#string) [Testing](#testing) [Utilities](#utilities) +----------------------- ---------------------- ---------------------------- ------------------------- </div> -<a name="allocator"></a> - ## Allocator *Header file:* [allocator.h](api/allocator_8h.html) @@ -41,9 +39,7 @@ As the pointer to the memory area / pool can be arbitrarily chosen, any data can be provided to the memory management functions. One example is the -[UCX Memory Pool](#mempool). - -<a name="avl"></a> +[UCX Memory Pool](#memory-pool). ## AVL Tree @@ -55,8 +51,6 @@ All common binary tree operations are implemented. Furthermore, this module provides search functions via lower and upper bounds. -<a name="buffer"></a> - ## Buffer *Header file:* [buffer.h](api/buffer_8h.html) @@ -64,7 +58,7 @@ Instances of this buffer implementation can be used to read from or to write to memory like you would do with a stream. This allows the use of -`ucx_stream_copy` from the [Utilities](#utils) module to copy contents from one +`ucx_stream_copy` from the [Utilities](#utilities) module to copy contents from one buffer to another or from file or network streams to the buffer and vice-versa. @@ -73,8 +67,6 @@ See the documentation of the macro constants in the header file for more information. -<a name="list"></a> - ## List *Header file:* [list.h](api/list_8h.html) @@ -84,8 +76,6 @@ linked list. Among the common operations like insert, remove, search and sort, we allow convenient iteration via a special `UCX_FOREACH` macro. -<a name="logging"></a> - ## Logging *Header file:* [logging.h](api/logging_8h.html) @@ -96,8 +86,6 @@ line number logged automatically when outputting a message. -<a name="map"></a> - ## Map *Header file:* [map.h](api/map_8h.html) @@ -107,8 +95,6 @@ chaining with linked lists. Similarly to the list module, we provide a `UCX_MAP_FOREACH` macro to conveniently iterate through the key/value pairs. -<a name="mempool"></a> - ## Memory Pool *Header file:* [mempool.h](api/mempool_8h.html) @@ -121,8 +107,6 @@ case, some external library allocated memory for you, which you wish to be destroyed together with this pool. -<a name="properties"></a> - ## Properties *Header file:* [properties.h](api/properties_8h.html) @@ -162,9 +146,6 @@ ucx_map_free(myprops); fclose(file); ``` - -<a name="stack"></a> - ## Stack *Header file:* [stack.h](api/stack_8h.html) @@ -179,8 +160,6 @@ A typical use case is an algorithm where you need to allocate and free large amounts of memory very frequently. -<a name="string"></a> - ## String *Header file:* [string.h](api/string_8h.html) @@ -264,8 +243,6 @@ The memory pool ensures, that all strings are freed. -<a name="test"></a> - ## Testing *Header file:* [test.h](api/test_8h.html) @@ -276,8 +253,6 @@ To avoid code duplication within tests, we also provide the possibility to define test subroutines. -<a name="utils"></a> - ## Utilities *Header file:* [utils.h](api/utils_8h.html)