[MERGED] libosmo-netif[master]: osmux_snprintf: Add doxygen doc

[Pau Espin Pedrol]

Pau Espin Pedrol has submitted this change and it was merged.

Change subject: osmux_snprintf: Add doxygen doc
......................................................................


osmux_snprintf: Add doxygen doc

Change-Id: Idb3fcf25be9558bfc2f822352c07ebc2cb7d5caa
---
M src/osmux.c
1 file changed, 10 insertions(+), 1 deletion(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/src/osmux.c b/src/osmux.c
index 0027a51..7beb705 100644
--- a/src/osmux.c
+++ b/src/osmux.c
@@ -892,7 +892,16 @@
 	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)
 {
 	unsigned int remain = size;

-- 
To view, visit https://gerrit.osmocom.org/4387
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Idb3fcf25be9558bfc2f822352c07ebc2cb7d5caa
Gerrit-PatchSet: 2
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Owner: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: Pablo Neira Ayuso <pablo at gnumonks.org>
Gerrit-Reviewer: Pau Espin Pedrol <pespin at sysmocom.de>