espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-28 22:57:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add note/comment to describe the behavior of otAddUnicastAddress() (#220)

Browse Source 
This commit changes the documentation for `otAddUnicastAddress` in
"openthread.h" to describe/clarify its behavior.
This commit is contained in:
Abtin Keshavarzian
2016-06-28 12:27:14 -07:00
committed by Jonathan Hui
parent 4cddb988a3
commit d365f3aaa3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread.h
+4
View File
@@ -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.