Change in libosmocore[master]: utils.c: fix various inaccurate API doc about return values

[laforge]

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/16155 )

Change subject: utils.c: fix various inaccurate API doc about return values
......................................................................

utils.c: fix various inaccurate API doc about return values

Change-Id: I9ee6416decd23f8d5d634197620a63ae408cead3
---
M src/utils.c
1 file changed, 3 insertions(+), 4 deletions(-)

Approvals:
  Jenkins Builder: Verified
  fixeria: Looks good to me, approved
  laforge: Looks good to me, approved



diff --git a/src/utils.c b/src/utils.c
index ea1de0f..6fc2ee6 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -280,7 +280,7 @@
  * \param[out] buf_len size of buf in bytes
  * \param[in] bits A sequence of unpacked bits
  * \param[in] len Length of bits
- * \returns string representation in static buffer.
+ * \return The output buffer (buf).
  */
 char *osmo_ubit_dump_buf(char *buf, size_t buf_len, const uint8_t *bits, unsigned int len)
 {
@@ -672,7 +672,7 @@
  * \param[in] bufsize  sizeof(buf).
  * \param[in] str  A string that may contain any characters.
  * \param[in] in_len  Pass -1 to print until nul char, or >= 0 to force a length (also past nul chars).
- * \return Number of characters that would be written if bufsize were large enough excluding '\0' (like snprintf()).
+ * \return The output buffer (buf).
  */
 char *osmo_escape_str_buf2(char *buf, size_t bufsize, const char *str, int in_len)
 {
@@ -763,7 +763,7 @@
  * \param[in] bufsize  sizeof(buf).
  * \param[in] str  A string that may contain any characters.
  * \param[in] in_len  Pass -1 to print until nul char, or >= 0 to force a length.
- * \return Number of characters that would be written if bufsize were large enough excluding '\0' (like snprintf()).
+ * \return The output buffer (buf).
  */
 char *osmo_quote_str_buf2(char *buf, size_t bufsize, const char *str, int in_len)
 {
@@ -808,7 +808,6 @@
 }
 
 /*! Like osmo_quote_str_buf() but returns the result in a dynamically-allocated buffer.
- * The static buffer is shared with get_value_string() and osmo_escape_str().
  * \param[in] str  A string that may contain any characters.
  * \param[in] in_len  Pass -1 to print until nul char, or >= 0 to force a length.
  * \returns dynamically-allocated buffer containing a quoted and escaped representation.

-- 
To view, visit https://gerrit.osmocom.org/c/libosmocore/+/16155
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: I9ee6416decd23f8d5d634197620a63ae408cead3
Gerrit-Change-Number: 16155
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <axilirator at gmail.com>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20191122/c6accbaa/attachment.htm>