summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugene Syromyatnikov <evgsyr@gmail.com>2021-09-20 02:12:16 +0200
committerEugene Syromyatnikov <evgsyr@gmail.com>2021-10-12 00:35:30 +0200
commit51c8f3e456fc208deadafc8d90404c63399f3196 (patch)
treeee9007e500ea83750a05b20ccc68b65599562058
parent17c0945526ba1b30c476fa5534aec6fcac7340c9 (diff)
downloadstrace-51c8f3e456fc208deadafc8d90404c63399f3196.tar.gz
xlat: update printxvals_ex doxygen
* src/xlat.c (printxvals_ex): Update the doxygen comment.
-rw-r--r--src/xlat.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/src/xlat.c b/src/xlat.c
index 83d26d2df..b240fdd34 100644
--- a/src/xlat.c
+++ b/src/xlat.c
@@ -200,15 +200,16 @@ xlookup_le(const struct xlat *xlat, uint64_t *val)
}
/**
- * Print entry in struct xlat table, if there.
+ * Print an entry in struct xlat table, if it is there.
*
- * @param val Value to search a literal representation for.
- * @param dflt String (abbreviated in comment syntax) which should be emitted
+ * @param val A value to search a literal representation for.
+ * @param dflt A string (encased in comment syntax) which is to be emitted
* if no appropriate xlat value has been found.
- * @param style Style in which xlat value should be printed.
- * @param xlat (And the following arguments) Pointers to arrays of xlat values.
+ * @param style A style which is to be used for xlat value printing.
+ * @param xlat (and the following arguments) Pointers xlat description
+ * structures.
* The last argument should be NULL.
- * @return 1 if appropriate xlat value has been found, 0 otherwise.
+ * @return 1 if an appropriate xlat value has been found, 0 otherwise.
*/
int
printxvals_ex(const uint64_t val, const char *dflt, enum xlat_style style,