osmux_snprintf: Add doxygen doc
Change-Id: Idb3fcf25be9558bfc2f822352c07ebc2cb7d5caa
This commit is contained in:
parent
77d08a67b5
commit
d8f2b38eb9
11
src/osmux.c
11
src/osmux.c
|
@ -892,7 +892,16 @@ static int osmux_snprintf_payload(char *buf, size_t size,
|
||||||
return offset;
|
return offset;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*! Print osmux header fields and payload from msg into buffer buf.
|
||||||
|
* \param[out] buf buffer to store the output into
|
||||||
|
* \param[in] len length of buf in bytes
|
||||||
|
* \param[in] msgb message buffer containing one or more osmux frames
|
||||||
|
* \returns the number of characters printed (excluding the null byte used to end output to strings).
|
||||||
|
*
|
||||||
|
* If the output was truncated due to this limit, then the return value is the number of characters
|
||||||
|
* (excluding the terminating null byte) which would have been written to the final string if enough
|
||||||
|
* space had been available.
|
||||||
|
*/
|
||||||
int osmux_snprintf(char *buf, size_t size, struct msgb *msg)
|
int osmux_snprintf(char *buf, size_t size, struct msgb *msg)
|
||||||
{
|
{
|
||||||
unsigned int remain = size;
|
unsigned int remain = size;
|
||||||
|
|
Loading…
Reference in New Issue