net: Improve documentation for string_to_ip()

Signed-off-by: Joe Hershberger <joe.hershberger@ni.com>

diff --git a/include/net.h b/include/net.h
index 22c83bc21375fa8cd30de5bccef2946f0f103000..834f2449826a96994738f0252205945ca38a6637 100644 (file)
--- 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);