[PATCH] libosmocore[master]: api doc: get_value_string(): mention composition in static b...

[Neels Hofmeyr]

Review at  https://gerrit.osmocom.org/229

api doc: get_value_string(): mention composition in static buffer

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


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/29/229/1

diff --git a/src/utils.c b/src/utils.c
index 1c2fc32..e76297f 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -43,6 +43,10 @@
  *  \param[in] vs Array of value_string tuples
  *  \param[in] val Value to be converted
  *  \returns pointer to human-readable string
+ *
+ * If val is found in vs, the array's string entry is returned. Otherwise, an
+ * "unknown" string containing the actual value is composed in a static buffer
+ * that is reused across invocations.
  */
 const char *get_value_string(const struct value_string *vs, uint32_t val)
 {

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: I93dad98711ef69f8a1e196efa029a842a1ff5bd6
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>