From e7483f2e6409fd920c97395f7aa2b9eae5049aa4 Mon Sep 17 00:00:00 2001
From: goldsimon <goldsimon>
Date: Tue, 20 Nov 2007 21:23:24 +0000
Subject: [PATCH] Added return value comments to netconn_gethostbyname

---
 src/api/api_lib.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/api/api_lib.c b/src/api/api_lib.c
index d24a793b..f2a4adac 100644
--- a/src/api/api_lib.c
+++ b/src/api/api_lib.c
@@ -572,7 +572,10 @@ netconn_join_leave_group(struct netconn *conn,
  *
  * @param name a string representation of the DNS host name to query
  * @param addr a preallocated struct ip_addr where to store the resolved IP address
- * @return an error returned by the dns module, ERR_OK if resolving succeeded
+ * @return ERR_OK: resolving succeeded
+ *         ERR_MEM: memory error, try again later
+ *         ERR_ARG: dns client not initialized or invalid hostname
+ *         ERR_VAL: dns server response was invalid
  */
 err_t
 netconn_gethostbyname(const char *name, struct ip_addr *addr)