1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-27 15:31:17 +01:00

sys/string_utils: make swprintf() appear in doc

This commit is contained in:
Benjamin Valentin 2025-04-24 15:24:32 +02:00
parent f045ccc34a
commit 2377e758c1

View File

@ -87,6 +87,7 @@ static inline const char *string_writer_str(const string_writer_t *sw)
return sw->start;
}
#ifndef DOXYGEN
/**
* @brief internal helper macro
*/
@ -96,6 +97,8 @@ static inline const char *string_writer_str(const string_writer_t *sw)
#define __swprintf swprintf
__attribute__ ((format (printf, 2, 3)))
#endif
int __swprintf(string_writer_t *sw, FLASH_ATTR const char *restrict format, ...);
#else
/**
* @brief Write a formatted string to a buffer
* The string will be truncated if there is not enough space left in
@ -106,9 +109,10 @@ __attribute__ ((format (printf, 2, 3)))
* @param[in] format format string to write
*
* @return number of bytes written on success
* -E2BIG if the string was truncated
* @retval -E2BIG if the string was truncated
*/
int __swprintf(string_writer_t *sw, FLASH_ATTR const char *restrict format, ...);
int swprintf(string_writer_t *sw, FLASH_ATTR const char *restrict format, ...);
#endif /* DOXYGEN */
#if IS_ACTIVE(HAS_FLASH_UTILS_ARCH)
#define swprintf(sw, fmt, ...) flash_swprintf(sw, TO_FLASH(fmt), ## __VA_ARGS__)