From d365f3aaa303f94baf31a737e37a54ecfc472d4e Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Tue, 28 Jun 2016 12:27:14 -0700 Subject: [PATCH] Add note/comment to describe the behavior of otAddUnicastAddress() (#220) This commit changes the documentation for `otAddUnicastAddress` in "openthread.h" to describe/clarify its behavior. --- include/openthread.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/openthread.h b/include/openthread.h index 74f410041..ef78e6014 100644 --- a/include/openthread.h +++ b/include/openthread.h @@ -441,6 +441,10 @@ const otNetifAddress *otGetUnicastAddresses(void); /** * Add a Network Interface Address to the Thread interface. * + * The passed in instance @p aAddress will be added and stored by the Thread interface, so the caller should ensure + * that the address instance remains valid (not de-alloacted) and is not modified after a successful call to this + * method. + * * @param[in] aAddress A pointer to a Network Interface Address. * * @retval kThreadErrorNone Successfully added the Network Interface Address.