Change in libosmocore[master]: api doc: clarify 'returns' of gsm48_mi_to_string()

[neels]

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmocore/+/18476 )


Change subject: api doc: clarify 'returns' of gsm48_mi_to_string()
......................................................................

api doc: clarify 'returns' of gsm48_mi_to_string()

Change-Id: I81646ff8284061a60c208bd8f9233f66c3e410f8
---
M src/gsm/gsm48.c
1 file changed, 4 insertions(+), 2 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/76/18476/1

diff --git a/src/gsm/gsm48.c b/src/gsm/gsm48.c
index 17b0829..43b10b7 100644
--- a/src/gsm/gsm48.c
+++ b/src/gsm/gsm48.c
@@ -737,10 +737,12 @@
  *  \param[in] str_len Length of \a string in bytes
  *  \param[in] mi Mobile Identity to be stringified
  *  \param[in] mi_len Length of \a mi in bytes
- *  \returns WARNING: the return value of this function is not well implemented.
+ *  \returns Return <= 0 on error, > 0 on success.
+ *           WARNING: the return value of this function is not well implemented.
  *           Depending on the MI type and amount of output buffer, this may return
  *           the nr of written bytes, or the written strlen(), or the snprintf()
- *           style strlen()-if-the-buffer-were-large-enough. */
+ *           style strlen()-if-the-buffer-were-large-enough.
+ */
 int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
 {
 	int rc;

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

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: I81646ff8284061a60c208bd8f9233f66c3e410f8
Gerrit-Change-Number: 18476
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr at sysmocom.de>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200525/6f7a5ef2/attachment.htm>