Mercurial > hg > ucx / changeset

     1.1 --- a/docs/src/modules.md	Wed May 02 18:42:04 2018 +0200
     1.2 +++ b/docs/src/modules.md	Wed May 02 18:47:22 2018 +0200
     1.3 @@ -15,16 +15,14 @@
     1.4  
     1.5  <div id="modules" align="center">
     1.6      
     1.7 ------------------------ ---------------------- ---------------------------- -------------------------
     1.8 -[Allocator](#allocator) [AVL&nbsp;Tree](#avl)  [Buffer](#buffer)            [List](#list)
     1.9 -[Logging](#logging)     [Map](#map)            [Memory&nbsp;Pool](#mempool) [Properties](#properties)
    1.10 -[Stack](#stack)         [String](#string)      [Testing](#test)             [Utilities](#utils)
    1.11 ------------------------ ---------------------- ---------------------------- -------------------------
    1.12 +----------------------- ----------------------      ----------------------------     -------------------------
    1.13 +[Allocator](#allocator) [AVL&nbsp;Tree](#avl-tree)  [Buffer](#buffer)                [List](#list)
    1.14 +[Logging](#logging)     [Map](#map)                 [Memory&nbsp;Pool](#memory-pool) [Properties](#properties)
    1.15 +[Stack](#stack)         [String](#string)           [Testing](#testing)              [Utilities](#utilities)
    1.16 +----------------------- ----------------------      ----------------------------     -------------------------
    1.17  
    1.18  </div>
    1.19  
    1.20 -<a name="allocator"></a>
    1.21 -
    1.22  ## Allocator
    1.23  
    1.24  *Header file:* [allocator.h](api/allocator_8h.html)  
    1.25 @@ -41,9 +39,7 @@
    1.26  
    1.27  As the pointer to the memory area / pool can be arbitrarily chosen, any data
    1.28  can be provided to the memory management functions. One example is the
    1.29 -[UCX Memory Pool](#mempool).
    1.30 -
    1.31 -<a name="avl"></a>
    1.32 +[UCX Memory Pool](#memory-pool).
    1.33  
    1.34  ## AVL Tree
    1.35  
    1.36 @@ -55,8 +51,6 @@
    1.37  All common binary tree operations are implemented. Furthermore, this module
    1.38  provides search functions via lower and upper bounds.
    1.39  
    1.40 -<a name="buffer"></a>
    1.41 -
    1.42  ## Buffer
    1.43  
    1.44  *Header file:* [buffer.h](api/buffer_8h.html)  
    1.45 @@ -64,7 +58,7 @@
    1.46  
    1.47  Instances of this buffer implementation can be used to read from or to write to
    1.48  memory like you would do with a stream. This allows the use of
    1.49 -`ucx_stream_copy` from the [Utilities](#utils) module to copy contents from one
    1.50 +`ucx_stream_copy` from the [Utilities](#utilities) module to copy contents from one
    1.51  buffer to another or from file or network streams to the buffer and
    1.52  vice-versa.
    1.53  
    1.54 @@ -73,8 +67,6 @@
    1.55  See the documentation of the macro constants in the header file for more
    1.56  information.
    1.57  
    1.58 -<a name="list"></a>
    1.59 -
    1.60  ## List
    1.61  
    1.62  *Header file:* [list.h](api/list_8h.html)  
    1.63 @@ -84,8 +76,6 @@
    1.64  linked list. Among the common operations like insert, remove, search and sort,
    1.65  we allow convenient iteration via a special `UCX_FOREACH` macro.
    1.66  
    1.67 -<a name="logging"></a>
    1.68 -
    1.69  ## Logging
    1.70  
    1.71  *Header file:* [logging.h](api/logging_8h.html)  
    1.72 @@ -96,8 +86,6 @@
    1.73  line number logged automatically when outputting a message.
    1.74  
    1.75  
    1.76 -<a name="map"></a>
    1.77 -
    1.78  ## Map
    1.79  
    1.80  *Header file:* [map.h](api/map_8h.html)  
    1.81 @@ -107,8 +95,6 @@
    1.82  chaining with linked lists. Similarly to the list module, we provide a
    1.83  `UCX_MAP_FOREACH` macro to conveniently iterate through the key/value pairs.
    1.84  
    1.85 -<a name="mempool"></a>
    1.86 -
    1.87  ## Memory Pool
    1.88  
    1.89  *Header file:* [mempool.h](api/mempool_8h.html)  
    1.90 @@ -121,8 +107,6 @@
    1.91  case, some external library allocated memory for you, which you wish to be
    1.92  destroyed together with this pool.
    1.93  
    1.94 -<a name="properties"></a>
    1.95 -
    1.96  ## Properties
    1.97  
    1.98  *Header file:* [properties.h](api/properties_8h.html)  
    1.99 @@ -162,9 +146,6 @@
   1.100  ucx_map_free(myprops);
   1.101  fclose(file);
   1.102  ```
   1.103 -
   1.104 -<a name="stack"></a>
   1.105 -
   1.106  ## Stack
   1.107  
   1.108  *Header file:* [stack.h](api/stack_8h.html)  
   1.109 @@ -179,8 +160,6 @@
   1.110  A typical use case is an algorithm where you need to allocate and free large
   1.111  amounts of memory very frequently.
   1.112  
   1.113 -<a name="string"></a>
   1.114 -
   1.115  ## String
   1.116  
   1.117  *Header file:* [string.h](api/string_8h.html)  
   1.118 @@ -264,8 +243,6 @@
   1.119  
   1.120  The memory pool ensures, that all strings are freed.
   1.121  
   1.122 -<a name="test"></a>
   1.123 -
   1.124  ## Testing
   1.125  
   1.126  *Header file:* [test.h](api/test_8h.html)  
   1.127 @@ -276,8 +253,6 @@
   1.128  To avoid code duplication within tests, we also provide the possibility to
   1.129  define test subroutines.
   1.130  
   1.131 -<a name="utils"></a>
   1.132 -
   1.133  ## Utilities
   1.134  
   1.135  *Header file:* [utils.h](api/utils_8h.html)