add docs for the compare.h and printf.h utilities

Tue, 27 Jun 2023 20:04:48 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 27 Jun 2023 20:04:48 +0200
changeset 725
c9b882bef838
parent 724
5e7b1951dc80
child 726
44986c0e2b05

add docs for the compare.h and printf.h utilities

docs/src/features.md file | annotate | diff | comparison | revisions
     1.1 --- a/docs/src/features.md	Tue Jun 27 18:44:37 2023 +0200
     1.2 +++ b/docs/src/features.md	Tue Jun 27 20:04:48 2023 +0200
     1.3 @@ -89,7 +89,7 @@
     1.4  
     1.5  ## Memory Pool
     1.6  
     1.7 -*Header file:* [mempool.h](api/mempool_8h.html)  
     1.8 +*Header file:* [mempool.h](api/mempool_8h.html)
     1.9  
    1.10  ### Basic Memory Pool
    1.11  
    1.12 @@ -162,6 +162,15 @@
    1.13  
    1.14  *Header file:* [printf.h](api/printf_8h.html)
    1.15  
    1.16 +In this utility header you can find `printf()`-like functions that can write the formatted output to an arbitrary
    1.17 +stream (or UCX buffer, resp.), or to memory allocated by an allocator within a single function call.
    1.18 +With the help of these convenience functions, you do not need to `snprintf` your string to a temporary buffer anymore,
    1.19 +plus you do not need to worry about too small buffer sizes, because the functions will automatically allocate enough
    1.20 +memory to contain the entire formatted string.
    1.21 +
    1.22  ### Compare Functions
    1.23  
    1.24  *Header file:* [compare.h](api/compare_8h.html)
    1.25 +
    1.26 +This header file contains a collection of compare functions for various data types.
    1.27 +Their signatures are designed to be compatible with the `cx_compare_func` function pointer type.

mercurial