From e914c6ab6aaae9eb1edd5dccc1f9636b42871c57 Mon Sep 17 00:00:00 2001 From: Yakun Xu Date: Sat, 3 Nov 2018 02:28:07 +0800 Subject: [PATCH] [docs] add otUdpSend() usage (#3220) --- include/openthread/udp.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/openthread/udp.h b/include/openthread/udp.h index ae336ddd7..c0bca7736 100644 --- a/include/openthread/udp.h +++ b/include/openthread/udp.h @@ -183,6 +183,13 @@ otError otUdpConnect(otUdpSocket *aSocket, otSockAddr *aSockName); * @param[in] aMessage A pointer to a message buffer. * @param[in] aMessageInfo A pointer to a message info structure. * + * If the return value is OT_ERROR_NONE, OpenThread takes ownership of @p aMessage, and the caller should no longer + * reference @p aMessage. If the return value is not OT_ERROR_NONE, the caller retains ownership of @p aMessage, + * including freeing @p aMessage if the message buffer is no longer needed. + * + * @retval OT_ERROR_NONE The message is successfully scheduled for sending. + * @retval OT_ERROR_INVALID_ARGS Invalid arguments are given. + * * @sa otUdpNewMessage * @sa otUdpOpen * @sa otUdpClose