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

[docs] Doxygen fixes (#2308)

Browse Source
This commit is contained in:
Jeff Bumgardner
2017-10-31 22:37:22 -07:00
committed by Jonathan Hui
parent 7392200e9e
commit 977cd004bf
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/commissioner.h
+5 -5
View File
@@ -96,7 +96,7 @@ OTAPI otError OTCALL otCommissionerStop(otInstance *aInstance);
* @retval OT_ERROR_INVALID_ARGS @p aExtAddress or @p aPSKd is invalid.
* @retval OT_ERROR_INVALID_STATE The commissioner is not active.
*
* @note Only use this after successfully started the Commissioner role by otCommissionerStart().
* @note Only use this after successfully starting the Commissioner role with otCommissionerStart().
*
*/
OTAPI otError OTCALL otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aExtAddress,
@@ -113,7 +113,7 @@ OTAPI otError OTCALL otCommissionerAddJoiner(otInstance *aInstance, const otExtA
* @retval OT_ERROR_INVALID_ARGS @p aExtAddress is invalid.
* @retval OT_ERROR_INVALID_STATE The commissioner is not active.
*
* @note Only use this after successfully started the Commissioner role by otCommissionerStart().
* @note Only use this after successfully starting the Commissioner role with otCommissionerStart().
*
*/
OTAPI otError OTCALL otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aExtAddress);
@@ -143,7 +143,7 @@ OTAPI otError OTCALL otCommissionerSetProvisioningUrl(otInstance *aInstance, con
* @retval OT_ERROR_NO_BUFS Insufficient buffers to generate an Announce Begin message.
* @retval OT_ERROR_INVALID_STATE The commissioner is not active.
*
* @note Only use this after successfully started the Commissioner role by otCommissionerStart().
* @note Only use this after successfully starting the Commissioner role with otCommissionerStart().
*
*/
OTAPI otError OTCALL otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount,
@@ -178,7 +178,7 @@ typedef void (OTCALL *otCommissionerEnergyReportCallback)(uint32_t aChannelMask,
* @retval OT_ERROR_NO_BUFS Insufficient buffers to generate an Energy Scan Query message.
* @retval OT_ERROR_INVALID_STATE The commissioner is not active.
*
* @note Only use this after successfully started the Commissioner role by otCommissionerStart().
* @note Only use this after successfully starting the Commissioner role with otCommissionerStart().
*
*/
OTAPI otError OTCALL otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount,
@@ -209,7 +209,7 @@ typedef void (OTCALL *otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint
* @retval OT_ERROR_NO_BUFS Insufficient buffers to generate a PAN ID Query message.
* @retval OT_ERROR_INVALID_STATE The commissioner is not active.
*
* @note Only use this after successfully started the Commissioner role by otCommissionerStart().
* @note Only use this after successfully starting the Commissioner role with otCommissionerStart().
*
*/
OTAPI otError OTCALL otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask,
include/openthread/openthread.h
+1
View File
@@ -102,6 +102,7 @@ extern "C" {
* @defgroup api-joiner Joiner
* @defgroup api-thread-router Router/Leader
* @brief This module includes functions for Thread Routers and Leaders.
* @defgroup api-server Server
* @defgroup api-tmf-proxy TMF Proxy
*
* @}
include/openthread/server.h
+1 -1
View File
@@ -115,7 +115,7 @@ OTAPI otError OTCALL otServerGetNextService(otInstance *aInstance, otNetworkData
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
* retval OT_ERROR_NONE Successfully queued a Server Data Request message for delivery.
* @retval OT_ERROR_NONE Successfully queued a Server Data Request message for delivery.
*
* @sa otServerAddService
* @sa otServerRemoveService