From c88ec7e2914a5b85fd878e4ee96f31aa26be05c8 Mon Sep 17 00:00:00 2001 From: Bryce Harrington Date: Fri, 8 Jul 2016 16:51:16 -0700 Subject: [PATCH] scanner: Improve documentation for strtouint() Signed-off-by: Bryce Harrington Reviewed-by: Yong Bakos --- src/scanner.c | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/scanner.c b/src/scanner.c index 4708cae0..6e2c3a3b 100644 --- a/src/scanner.c +++ b/src/scanner.c @@ -576,8 +576,17 @@ free_interface(struct interface *interface) free(interface); } -/* convert string to unsigned integer, - * in the case of error, return -1 */ +/* Convert string to unsigned integer + * + * Parses a non-negative base-10 number from the given string. If the + * specified string is blank, contains non-numerical characters, is out + * of range, or results in a negative number, -1 is returned to indicate + * an error. + * + * Upon error, this routine does not modify or set errno. + * + * \returns -1 on error, or a non-negative integer on success + */ static int strtouint(const char *str) {