From 04dfda89270838678261f543ba2abc5ce4c0b30c Mon Sep 17 00:00:00 2001 From: Jukka Rissanen Date: Mon, 3 Aug 2015 10:40:08 +0300 Subject: [PATCH] net: Fix the documentation of net_release() Fixed the description of what happens if there is a timeout. Change-Id: Id19a791193b527a8ee086f069e103f42d2d9b0f4 Signed-off-by: Jukka Rissanen --- include/net/net_socket.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/net/net_socket.h b/include/net/net_socket.h index 5f51f9d9ae6..4a67da62df6 100644 --- a/include/net/net_socket.h +++ b/include/net/net_socket.h @@ -105,9 +105,9 @@ int net_send(struct net_buf *buf); * @brief Receive data from network. * * @details Application uses this to get data from network - * connection. This function will not wait so if there is - * no data to return, then NULL is returned. Caller is - * responsible to release the returned net_buf. + * connection. Caller can specify a timeout, if there is no + * data to return after a timeout, a NULL will be returned. + * Caller is responsible to release the returned net_buf. * * @param context Network context. * @param timeout Timeout to wait. The value is in ticks. @@ -116,7 +116,7 @@ int net_send(struct net_buf *buf); * If > 0, wait amount of ticks. * The timeout is only available if kernel is compiled * with CONFIG_NANO_TIMEOUTS. If CONFIG_NANO_TIMEOUT is not - * defined, then value > 0 means to not wait. + * defined, then value > 0 means not to wait. * * @return Network buffer if successful, NULL otherwise. */