From 63b6da6ae7403567643c6e435d5bbbbda733b462 Mon Sep 17 00:00:00 2001
From: Steffen Vogel <post@steffenvogel.de>
Date: Sun, 19 Nov 2017 11:38:00 +0100
Subject: [PATCH] improve documentation of HandleSet_waitReady()

---
 src/hal/inc/hal_ethernet.h | 13 ++++++-------
 src/hal/inc/hal_socket.h   | 13 ++++++-------
 2 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/src/hal/inc/hal_ethernet.h b/src/hal/inc/hal_ethernet.h
index 5fa6e412..dd9e7ea4 100644
--- a/src/hal/inc/hal_ethernet.h
+++ b/src/hal/inc/hal_ethernet.h
@@ -68,18 +68,17 @@ EthernetHandleSet_new(void);
 void
 EthernetHandleSet_addSocket(EthernetHandleSet self, const EthernetSocket sock);
 
-
 /**
  * \brief wait for a socket to become ready
  *
  * This function is corresponding to the BSD socket select function.
- * It returns the number of sockets on which data is pending or 0 if no data is pending
- * on any of the monitored connections. The function will return after "timeout" ms if no
- * data is pending.
- * The function shall return -1 if a socket error occures.
+ * The function will return after \p timeoutMs ms if no data is pending.
  *
- *  \param self the EthernetHandleSet instance
- *  \param timeout in milliseconds (ms)
+ * \param self the HandleSet instance
+ * \param timeout in milliseconds (ms)
+ * \return It returns the number of sockets on which data is pending
+ *   or 0 if no data is pending on any of the monitored connections.
+ *   The function shall return -1 if a socket error occures.
  */
 int
 EthernetHandleSet_waitReady(EthernetHandleSet self, unsigned int timeoutMs);
diff --git a/src/hal/inc/hal_socket.h b/src/hal/inc/hal_socket.h
index c9520579..3fddd3f2 100644
--- a/src/hal/inc/hal_socket.h
+++ b/src/hal/inc/hal_socket.h
@@ -71,18 +71,17 @@ Handleset_new(void);
 void
 Handleset_addSocket(HandleSet self, const Socket sock);
 
-
 /**
  * \brief wait for a socket to become ready
  *
  * This function is corresponding to the BSD socket select function.
- * It returns the number of sockets on which data is pending or 0 if no data is pending
- * on any of the monitored connections. The function will return after "timeout" ms if no
- * data is pending.
- * The function shall return -1 if a socket error occures.
+ * The function will return after \p timeoutMs ms if no data is pending.
  *
- *  \param self the HandleSet instance
- *  \param timeout in milliseconds (ms)
+ * \param self the HandleSet instance
+ * \param timeout in milliseconds (ms)
+ * \return It returns the number of sockets on which data is pending
+ *   or 0 if no data is pending on any of the monitored connections.
+ *   The function shall return -1 if a socket error occures.
  */
 int
 Handleset_waitReady(HandleSet self, unsigned int timeoutMs);