diff options
author | Joe Hershberger <joe.hershberger@ni.com> | 2019-09-13 19:29:41 -0500 |
---|---|---|
committer | Joe Hershberger <joe.hershberger@ni.com> | 2019-12-09 09:47:41 -0600 |
commit | d724321f99bbaf024a5ec4bacf1520de3bc1ac87 (patch) | |
tree | 6871f675cfdb1e74b87d4a6c49c6a8e37b06d771 /include/net.h | |
parent | fb8977c5be93f8e967df224fe0a44721d60e34dc (diff) |
net: Improve documentation for string_to_ip()
Signed-off-by: Joe Hershberger <joe.hershberger@ni.com>
Diffstat (limited to 'include/net.h')
-rw-r--r-- | include/net.h | 7 |
1 files 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); |