RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

sys/fmt: add some documentation about out

Browse Source
This commit is contained in:
Kaspar Schleiser 2021-11-22 11:29:46 +01:00
parent 2902e31ff8
commit 62772ab3f9
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
sys/include/fmt.h
View File

@ -18,7 +18,14 @@
* integers, even when the C library was built without support for 64 bit
* formatting (newlib-nano).
*
* \note The print functions in this library do not buffer any output.
* @note The fmt functions expect their `out` parameter to hold the entire output.
* This *MUST* be ensured by the caller.
*
* @note Each fmt function will not write anything to `out` if it is `NULL`, but
* still return the number of bytes that would have been written.
* This can be used to ensure the `out` buffer is large enough.
*
* @note The print functions in this library do not buffer any output.
* Mixing calls to standard @c printf from stdio.h with the @c print_xxx
* functions in fmt, especially on the same output line, may cause garbled
* output.