From 8a3c83ed00104bdb326c160a36c8f2b0625eeabd Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 13 Jun 2016 13:16:58 +0200 Subject: api doc: get_value_string(): mention composition in static buffer Change-Id: I93dad98711ef69f8a1e196efa029a842a1ff5bd6 Reviewed-on: https://gerrit.osmocom.org/229 Reviewed-by: Harald Welte Tested-by: Jenkins Builder --- src/utils.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/utils.c b/src/utils.c index 1c2fc326..e76297ff 100644 --- a/src/utils.c +++ b/src/utils.c @@ -43,6 +43,10 @@ static char namebuf[255]; * \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) { -- cgit v1.2.3