From: Andre <maan@p133.(none)>
Date: Tue, 13 Jun 2006 01:14:33 +0000 (+0200)
Subject: fix documentation of get_host_info()
X-Git-Tag: v0.2.14~62^2~13
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=ef915594659eb6e0ced39759c68637647cb50c95;p=paraslash.git

fix documentation of get_host_info()
---

diff --git a/net.c b/net.c
index 74b8e1f7..6c4bbf98 100644
--- a/net.c
+++ b/net.c
@@ -224,8 +224,12 @@ int recv_buffer(int fd, char *buf, ssize_t size)
 /**
  * wrapper around gethostbyname
  *
- * @param host hostname or IPv4 address
- * \return The hostent structure or a NULL pointer if an error occurs
+ * \param host hostname or IPv4 address
+ * \param ret the hostent structure is returned here
+ *
+ * \return positive on success, negative on errors. On success, \a ret
+ * contains the return value of the underlying gethostbyname() call.
+ *
  * \sa gethostbyname(2)
  */
 int get_host_info(char *host, struct hostent **ret)