diff options
author | Neels Hofmeyr <neels@hofmeyr.de> | 2020-05-25 23:05:04 +0200 |
---|---|---|
committer | Neels Hofmeyr <neels@hofmeyr.de> | 2020-05-26 22:30:49 +0200 |
commit | 512bf02e41bd7e4cbd3ce7a066fd77cedd0fa7c5 (patch) | |
tree | 38718f578404115cd7ead8cb149c68b13cfcfff3 | |
parent | a299139129ff72ed3aa84ed5aa44b5f9f8a227ae (diff) |
api doc: clarify 'returns' of gsm48_mi_to_string()
Change-Id: I81646ff8284061a60c208bd8f9233f66c3e410f8
-rw-r--r-- | src/gsm/gsm48.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/gsm/gsm48.c b/src/gsm/gsm48.c index 17b0829d..43b10b78 100644 --- a/src/gsm/gsm48.c +++ b/src/gsm/gsm48.c @@ -737,10 +737,12 @@ int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi) * \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; |