From 3c88ba28fb8235835fc97f214e2dcfa62269dde0 Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Fri, 12 Oct 2018 22:16:36 -0700 Subject: [PATCH] [docs] specify seconds as the unit for child timeout value (#3145) --- include/openthread/thread.h | 4 ++-- src/core/thread/mle.hpp | 4 +++- src/ncp/spinel.h | 1 + 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/include/openthread/thread.h b/include/openthread/thread.h index 8627d81da..b7b8e16b8 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -281,7 +281,7 @@ OTAPI bool OTCALL otThreadIsDiscoverInProgress(otInstance *aInstance); * * @param[in] aInstance A pointer to an OpenThread instance. * - * @returns The Thread Child Timeout value. + * @returns The Thread Child Timeout value in seconds. * * @sa otThreadSetChildTimeout */ @@ -291,7 +291,7 @@ OTAPI uint32_t OTCALL otThreadGetChildTimeout(otInstance *aInstance); * Set the Thread Child Timeout used when operating in the Child role. * * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aTimeout The timeout value. + * @param[in] aTimeout The timeout value in seconds. * * @sa otThreadSetChildTimeout * diff --git a/src/core/thread/mle.hpp b/src/core/thread/mle.hpp index 69d4ddedf..c4ccad284 100644 --- a/src/core/thread/mle.hpp +++ b/src/core/thread/mle.hpp @@ -798,7 +798,7 @@ public: /** * This method returns the MLE Timeout value. * - * @returns The MLE Timeout value. + * @returns The MLE Timeout value in seconds. * */ uint32_t GetTimeout(void) const { return mTimeout; } @@ -806,6 +806,8 @@ public: /** * This method sets the MLE Timeout value. * + * @param[in] aTimeout The Timeout value in seconds. + * */ otError SetTimeout(uint32_t aTimeout); diff --git a/src/ncp/spinel.h b/src/ncp/spinel.h index a0add20a1..eb3d3f41a 100644 --- a/src/ncp/spinel.h +++ b/src/ncp/spinel.h @@ -1088,6 +1088,7 @@ typedef enum { /// Thread Child Timeout /** Format: `L` + * Unit: Seconds * * Used when operating in the Child role. */