net: Improve documentation for string_to_ip()

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

net: Improve documentation for string_to_ip()
Signed-off-by: Joe Hershberger <joe.hershberger@ni.com>
Joe Hershberger
1 parent fb8977c5be
Showing 1 changed file with 4 additions and 3 deletions Side-by-side Diff
include/net.h
@@ -845,9 +845,10 @@
 /**
  * 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);
...	...	@@ -845,9 +845,10 @@
845	845	/**
846	846	* string_to_ip() - Convert a string to ip address
847	847	*
848		- * @s: String to conver, in the format format a.b.c.d, where each value is a
849		- * decimal number from 0 to 255
850		- * @return IP address, or 0 if invalid
	848	+ * Implemented in lib/net_utils.c (built unconditionally)
	849	+ *
	850	+ * @s: Input string to parse
	851	+ * @return: in_addr struct containing the parsed IP address
851	852	*/
852	853	struct in_addr string_to_ip(const char *s);
853	854