changeset
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 |
--- a/docs/src/features.md Tue Jun 27 18:44:37 2023 +0200 +++ b/docs/src/features.md Tue Jun 27 20:04:48 2023 +0200 @@ -89,7 +89,7 @@ ## Memory Pool -*Header file:* [mempool.h](api/mempool_8h.html) +*Header file:* [mempool.h](api/mempool_8h.html) ### Basic Memory Pool @@ -162,6 +162,15 @@ *Header file:* [printf.h](api/printf_8h.html) +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, +plus you do not need to worry about too small buffer sizes, because the functions will automatically allocate enough +memory to contain the entire formatted string. + ### Compare Functions *Header file:* [compare.h](api/compare_8h.html) + +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.
