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

[docs] fix reference to old function name in link.h (#4134)

Browse Source 
otSetChildTimeout -> otThreadSetChildTimeout
This commit is contained in:
Ciaran Woodward
2019-08-29 13:22:09 -07:00
committed by Jonathan Hui
parent 3cd4be9392
commit 3ddc4fe98c
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/link.h
+1 -1
View File
@@ -425,7 +425,7 @@ uint32_t otLinkGetPollPeriod(otInstance *aInstance);
* Set/clear user-specified/external data poll period for sleepy end device.
*
* @note This function updates only poll period of sleepy end device. To update child timeout the function
* `otSetChildTimeout()` shall be called.
* `otThreadSetChildTimeout()` shall be called.
*
* @note Minimal non-zero value should be `OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD` (10ms).
* Or zero to clear user-specified poll period.