diff mbox series

[U-Boot] net: Improve documentation for string_to_ip()

Message ID 20190914004332.58642-1-joe.hershberger@ni.com
State Accepted
Commit d724321f99
Delegated to: Joe Hershberger
Headers show
Series [U-Boot] net: Improve documentation for string_to_ip() | expand

Commit Message

Joe Hershberger Sept. 14, 2019, 12:43 a.m. UTC 
Signed-off-by: Joe Hershberger <joe.hershberger@ni.com>

---

 include/net.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/net.h b/include/net.h
index d054c5f694..a4d0b41b20 100644
--- a/include/net.h
+++ b/include/net.h
@@ -841,7 +841,14 @@  void string_to_enetaddr(const char *addr, uint8_t *enetaddr);
 /* Convert an IP address to a string */
 void ip_to_string(struct in_addr x, char *s);
 
-/* Convert a string to ip address */
+/**
+ * string_to_ip() - Convert a string to ip address
+ *
+ * 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);
 
 /* Convert a VLAN id to a string */