From 75df7a26fbabef80faa0f2a71b549c225fc68320 Mon Sep 17 00:00:00 2001 From: gavinmcgovern <81183035+gavinmcgovern@users.noreply.github.com> Date: Mon, 12 Jul 2021 14:48:02 -0700 Subject: [PATCH] [docs] change thrNetworkKey for docs (#6810) --- include/openthread/instance.h | 2 +- include/openthread/thread.h | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 8c3b4cfee..621bd6cda 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -53,7 +53,7 @@ extern "C" { * @note This number versions both OpenThread platform and user APIs. * */ -#define OPENTHREAD_API_VERSION (135) +#define OPENTHREAD_API_VERSION (136) /** * @addtogroup api-instance diff --git a/include/openthread/thread.h b/include/openthread/thread.h index 8498aa965..b3968ff3f 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -378,11 +378,11 @@ otLinkModeConfig otThreadGetLinkMode(otInstance *aInstance); otError otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig); /** - * Get the thrNetworkKey. + * Get the Thread Network Key. * * @param[in] aInstance A pointer to an OpenThread instance. * - * @returns A pointer to a buffer containing the thrNetworkKey. + * @returns A pointer to a buffer containing the Thread Network Key. * * @sa otThreadSetNetworkKey * @@ -390,16 +390,16 @@ otError otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig); const otNetworkKey *otThreadGetNetworkKey(otInstance *aInstance); /** - * Set the thrNetworkKey. + * Set the Thread Network Key. * * This function succeeds only when Thread protocols are disabled. A successful * call to this function invalidates the Active and Pending Operational Datasets in * non-volatile memory. * * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aKey A pointer to a buffer containing the thrNetworkKey. + * @param[in] aKey A pointer to a buffer containing the Thread Network Key. * - * @retval OT_ERROR_NONE Successfully set the thrNetworkKey. + * @retval OT_ERROR_NONE Successfully set the Thread Network Key. * @retval OT_ERROR_INVALID_ARGS If aKeyLength is larger than 16. * @retval OT_ERROR_INVALID_STATE Thread protocols are enabled. *