fix documentation of get_host_info()

diff --git a/net.c b/net.c
index 74b8e1f7eddbc6c76bbf0e717bb05df5311b3bb5..6c4bbf98e4308e58c1e442e12ab8da650cb52c74 100644 (file)
--- 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)