From d724321f99bbaf024a5ec4bacf1520de3bc1ac87 Mon Sep 17 00:00:00 2001 From: Joe Hershberger Date: Fri, 13 Sep 2019 19:29:41 -0500 Subject: [PATCH] net: Improve documentation for string_to_ip() Signed-off-by: Joe Hershberger --- include/net.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/net.h b/include/net.h index 22c83bc213..834f244982 100644 --- a/include/net.h +++ b/include/net.h @@ -845,9 +845,10 @@ void ip_to_string(struct in_addr x, char *s); /** * string_to_ip() - Convert a string to ip address * - * @s: String to conver, in the format format a.b.c.d, where each value is a - * decimal number from 0 to 255 - * @return IP address, or 0 if invalid + * Implemented in lib/net_utils.c (built unconditionally) + * + * @s: Input string to parse + * @return: in_addr struct containing the parsed IP address */ struct in_addr string_to_ip(const char *s);