From 0a74d66fedd3c9558ccf298055305a0eef5a6896 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Thu, 10 Mar 2022 14:34:20 -0800 Subject: [PATCH] [doxygen] change `inout` to `in,out` (#7461) --- .../simulation/platform-simulation.h | 20 +-- examples/platforms/utils/logging_rtt.c | 10 +- examples/platforms/utils/mac_frame.h | 6 +- include/openthread/backbone_router_ftd.h | 12 +- include/openthread/border_router.h | 26 +-- include/openthread/coap.h | 102 ++++++------ include/openthread/commissioner.h | 2 +- include/openthread/crypto.h | 34 ++-- include/openthread/history_tracker.h | 54 +++--- include/openthread/instance.h | 6 +- include/openthread/ip6.h | 4 +- include/openthread/link.h | 20 +-- include/openthread/netdata.h | 34 ++-- include/openthread/netdiag.h | 8 +- include/openthread/network_time.h | 4 +- include/openthread/platform/crypto.h | 14 +- include/openthread/platform/settings.h | 18 +- include/openthread/server.h | 18 +- include/openthread/thread.h | 8 +- include/openthread/thread_ftd.h | 22 +-- src/core/common/instance.hpp | 6 +- src/core/common/notifier.hpp | 6 +- src/core/common/settings_driver.hpp | 34 ++-- src/core/common/string.hpp | 4 +- src/core/common/uptime.hpp | 4 +- src/core/crypto/aes_ccm.hpp | 8 +- src/core/crypto/ecdsa.hpp | 12 +- src/core/crypto/storage.hpp | 20 +-- src/core/mac/channel_mask.hpp | 2 +- src/core/mac/mac_filter.hpp | 16 +- src/core/meshcop/commissioner.hpp | 2 +- src/core/net/checksum.hpp | 2 +- src/core/net/dns_types.hpp | 156 +++++++++--------- src/core/thread/address_resolver.hpp | 4 +- src/core/thread/neighbor_table.hpp | 6 +- src/core/thread/network_data.hpp | 42 ++--- src/core/thread/network_data_service.hpp | 8 +- src/core/thread/network_diagnostic.hpp | 7 +- src/core/thread/radio_selector.hpp | 6 +- src/core/thread/time_sync_service.hpp | 2 +- src/core/utils/flash.hpp | 18 +- src/core/utils/history_tracker.hpp | 45 ++--- src/core/utils/parse_cmdline.hpp | 18 +- src/core/utils/slaac_address.hpp | 8 +- src/lib/hdlc/hdlc.hpp | 10 +- src/posix/main.c | 4 +- src/posix/platform/hdlc_interface.hpp | 8 +- .../include/openthread/openthread-system.h | 4 +- .../openthread/platform/secure_settings.h | 18 +- src/posix/platform/infra_if.hpp | 2 +- src/posix/platform/mainloop.hpp | 4 +- src/posix/platform/platform-posix.h | 40 ++--- src/posix/platform/spi_interface.hpp | 8 +- src/posix/platform/system.cpp | 6 +- 54 files changed, 484 insertions(+), 478 deletions(-) diff --git a/examples/platforms/simulation/platform-simulation.h b/examples/platforms/simulation/platform-simulation.h index b0abf639d..4e7970b22 100644 --- a/examples/platforms/simulation/platform-simulation.h +++ b/examples/platforms/simulation/platform-simulation.h @@ -161,9 +161,9 @@ void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLen /** * This function updates the file descriptor sets with file descriptors used by the radio driver. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. * */ void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aMaxFd); @@ -187,9 +187,9 @@ void platformRandomInit(void); /** * This function updates the file descriptor sets with file descriptors used by the UART driver. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. * */ void platformUartUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd); @@ -250,10 +250,10 @@ void platformTrelDeinit(void); /** * This function updates the file descriptor sets with file descriptors used by the TREL. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aTimeout A pointer to the timeout. - * @param[inout] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aTimeout A pointer to the timeout. + * @param[in,out] aMaxFd A pointer to the max file descriptor. * */ void platformTrelUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd); diff --git a/examples/platforms/utils/logging_rtt.c b/examples/platforms/utils/logging_rtt.c index 3372cab13..e58db6509 100644 --- a/examples/platforms/utils/logging_rtt.c +++ b/examples/platforms/utils/logging_rtt.c @@ -93,8 +93,8 @@ static inline const char *levelToString(otLogLevel aLogLevel) /** * Function for printing actual timestamp. * - * @param[inout] aLogString Pointer to the log buffer. - * @param[in] aMaxSize Maximum size of the log buffer. + * @param[in,out] aLogString Pointer to the log buffer. + * @param[in] aMaxSize Maximum size of the log buffer. * * @returns Number of bytes successfully written to the log buffer. */ @@ -108,9 +108,9 @@ static inline int logTimestamp(char *aLogString, uint16_t aMaxSize) /** * Function for printing log level. * - * @param[inout] aLogString Pointer to log buffer. - * @param[in] aMaxSize Maximum size of log buffer. - * @param[in] aLogLevel Log level. + * @param[in,out] aLogString Pointer to log buffer. + * @param[in] aMaxSize Maximum size of log buffer. + * @param[in] aLogLevel Log level. * * @returns Number of bytes successfully written to the log buffer. */ diff --git a/examples/platforms/utils/mac_frame.h b/examples/platforms/utils/mac_frame.h index 1d6c39a81..8f0c6794f 100644 --- a/examples/platforms/utils/mac_frame.h +++ b/examples/platforms/utils/mac_frame.h @@ -228,7 +228,7 @@ otError otMacFrameGenerateEnhAck(const otRadioFrame *aFrame, /** * Set CSL IE content into the frame. * - * @param[inout] aFrame A pointer to the frame to be modified. + * @param[in,out] aFrame A pointer to the frame to be modified. * @param[in] aCslPeriod CSL Period in CSL IE. * @param[in] aCslPhase CSL Phase in CSL IE. * @@ -270,7 +270,7 @@ uint8_t otMacFrameGetKeyId(otRadioFrame *aFrame); /** * Set key ID to @p aFrame with key ID mode 1. * - * @param[inout] aFrame A pointer to the frame to be modified. + * @param[in,out] aFrame A pointer to the frame to be modified. * @param[in] aKeyId Key ID to be set to the frame. * */ @@ -289,7 +289,7 @@ uint32_t otMacFrameGetFrameCounter(otRadioFrame *aFrame); /** * Set frame counter to @p aFrame. * - * @param[inout] aFrame A pointer to the frame to be modified. + * @param[in,out] aFrame A pointer to the frame to be modified. * @param[in] aFrameCounter Frame counter to be set to the frame. * */ diff --git a/include/openthread/backbone_router_ftd.h b/include/openthread/backbone_router_ftd.h index 746d59927..a1b7f688a 100644 --- a/include/openthread/backbone_router_ftd.h +++ b/include/openthread/backbone_router_ftd.h @@ -304,12 +304,12 @@ typedef struct otBackboneRouterMulticastListenerInfo /** * This function gets the next Multicast Listener info (using an iterator). * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the iterator. On success the iterator will be updated to point to next - * Multicast Listener. To get the first entry the iterator should be set to - * OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT. - * @param[out] aListenerInfo A pointer to an `otBackboneRouterMulticastListenerInfo` where information of next - * Multicast Listener is placed (on success). + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the iterator. On success the iterator will be updated to point to next + * Multicast Listener. To get the first entry the iterator should be set to + * OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT. + * @param[out] aListenerInfo A pointer to an `otBackboneRouterMulticastListenerInfo` where information of next + * Multicast Listener is placed (on success). * * @retval OT_ERROR_NONE Successfully found the next Multicast Listener info (@p aListenerInfo was successfully * updated). diff --git a/include/openthread/border_router.h b/include/openthread/border_router.h index 4161e1925..b09ab205a 100644 --- a/include/openthread/border_router.h +++ b/include/openthread/border_router.h @@ -137,11 +137,11 @@ otError otBorderRoutingGetNat64Prefix(otInstance *aInstance, otIp6Prefix *aPrefi /** * This method provides a full or stable copy of the local Thread Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. - * @param[out] aData A pointer to the data buffer. - * @param[inout] aDataLength On entry, size of the data buffer pointed to by @p aData. - * On exit, number of copied bytes. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. + * @param[out] aData A pointer to the data buffer. + * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. + * On exit, number of copied bytes. */ otError otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength); @@ -177,10 +177,10 @@ otError otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefi /** * This function gets the next On Mesh Prefix in the local Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first on-mesh entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to the On Mesh Prefix information. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first on-mesh entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to the On Mesh Prefix information. * * @retval OT_ERROR_NONE Successfully found the next On Mesh prefix. * @retval OT_ERROR_NOT_FOUND No subsequent On Mesh prefix exists in the Thread Network Data. @@ -222,10 +222,10 @@ otError otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPre /** * This function gets the next external route in the local Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first external route entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to the External Route information. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first external route entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to the External Route information. * * @retval OT_ERROR_NONE Successfully found the next External Route. * @retval OT_ERROR_NOT_FOUND No subsequent external route entry exists in the Thread Network Data. diff --git a/include/openthread/coap.h b/include/openthread/coap.h index 396d53573..c2e036bb2 100644 --- a/include/openthread/coap.h +++ b/include/openthread/coap.h @@ -389,9 +389,9 @@ typedef otError (*otCoapBlockwiseReceiveHook)(void * aContext, * is enabled. * * @param[in] aContext A pointer to application-specific context. - * @param[inout] aBlock A pointer to where the block segment can be written to. + * @param[in,out] aBlock A pointer to where the block segment can be written to. * @param[in] aPosition The position in a sequence from which to obtain the block segment. - * @param[inout] aBlockLength On entry, the maximum block segment length in bytes. + * @param[in,out] aBlockLength On entry, the maximum block segment length in bytes. * @param[out] aMore A pointer to the flag if more block segments will follow. * * @warning By changing the value of aBlockLength, the block size of the whole exchange is @@ -485,9 +485,9 @@ typedef struct otCoapTxParameters /** * This function initializes the CoAP header. * - * @param[inout] aMessage A pointer to the CoAP message to initialize. - * @param[in] aType CoAP message type. - * @param[in] aCode CoAP message code. + * @param[in,out] aMessage A pointer to the CoAP message to initialize. + * @param[in] aType CoAP message type. + * @param[in] aCode CoAP message code. * */ void otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode); @@ -497,10 +497,10 @@ void otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode); * * @note Both message ID and token are set according to @p aRequest. * - * @param[inout] aResponse A pointer to the CoAP response message. - * @param[in] aRequest A pointer to the CoAP request message. - * @param[in] aType CoAP message type. - * @param[in] aCode CoAP message code. + * @param[in,out] aResponse A pointer to the CoAP response message. + * @param[in] aRequest A pointer to the CoAP request message. + * @param[in] aType CoAP message type. + * @param[in] aCode CoAP message code. * * @retval OT_ERROR_NONE Successfully initialized the response message. * @retval OT_ERROR_NO_BUFS Insufficient message buffers available to initialize the response message. @@ -511,9 +511,9 @@ otError otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aReques /** * This function sets the Token value and length in a header. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aToken A pointer to the Token value. - * @param[in] aTokenLength The Length of @p aToken. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aToken A pointer to the Token value. + * @param[in] aTokenLength The Length of @p aToken. * * @retval OT_ERROR_NONE Successfully set the Token value. * @retval OT_ERROR_NO_BUFS Insufficient buffers to set the Token value. @@ -524,8 +524,8 @@ otError otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_ /** * This function sets the Token length and randomizes its value. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aTokenLength The Length of a Token to set. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aTokenLength The Length of a Token to set. * */ void otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength); @@ -540,8 +540,8 @@ void otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength); * and if the desired format type code isn't listed in otCoapOptionContentFormat, * this base function should be used instead. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aContentFormat One of the content formats listed in + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aContentFormat One of the content formats listed in * otCoapOptionContentFormat above. * * @retval OT_ERROR_NONE Successfully appended the option. @@ -554,10 +554,10 @@ otError otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOption /** * This function appends a CoAP option in a header. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aNumber The CoAP Option number. - * @param[in] aLength The CoAP Option length. - * @param[in] aValue A pointer to the CoAP value. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aNumber The CoAP Option number. + * @param[in] aLength The CoAP Option length. + * @param[in] aValue A pointer to the CoAP value. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -570,9 +570,9 @@ otError otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_ * This function appends an unsigned integer CoAP option as specified in * https://tools.ietf.org/html/rfc7252#section-3.2 * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aNumber The CoAP Option number. - * @param[in] aValue The CoAP Option unsigned integer value. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aNumber The CoAP Option number. + * @param[in] aValue The CoAP Option unsigned integer value. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -585,8 +585,8 @@ otError otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uin /** * This function appends an Observe option. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aObserve Observe field value. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aObserve Observe field value. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -598,8 +598,8 @@ otError otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve) /** * This function appends a Uri-Path option. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aUriPath A pointer to a NULL-terminated string. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aUriPath A pointer to a NULL-terminated string. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -621,10 +621,10 @@ uint16_t otCoapBlockSizeFromExponent(otCoapBlockSzx aSize); /** * This function appends a Block2 option * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aNum Current block number. - * @param[in] aMore Boolean to indicate more blocks are to be sent. - * @param[in] aSize Block Size Exponent. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aNum Current block number. + * @param[in] aMore Boolean to indicate more blocks are to be sent. + * @param[in] aSize Block Size Exponent. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -636,10 +636,10 @@ otError otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool /** * This function appends a Block1 option * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aNum Current block number. - * @param[in] aMore Boolean to indicate more blocks are to be sent. - * @param[in] aSize Block Size Exponent. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aNum Current block number. + * @param[in] aMore Boolean to indicate more blocks are to be sent. + * @param[in] aSize Block Size Exponent. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -651,8 +651,8 @@ otError otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool /** * This function appends a Proxy-Uri option. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aUriPath A pointer to a NULL-terminated string. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aUriPath A pointer to a NULL-terminated string. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -664,8 +664,8 @@ otError otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriP /** * This function appends a Max-Age option. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aMaxAge The Max-Age value. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aMaxAge The Max-Age value. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -677,8 +677,8 @@ otError otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge); /** * This function appends a single Uri-Query option. * - * @param[inout] aMessage A pointer to the CoAP message. - * @param[in] aUriQuery A pointer to NULL-terminated string, which should contain a single key=value pair. + * @param[in,out] aMessage A pointer to the CoAP message. + * @param[in] aUriQuery A pointer to NULL-terminated string, which should contain a single key=value pair. * * @retval OT_ERROR_NONE Successfully appended the option. * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type. @@ -689,7 +689,7 @@ otError otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQ /** * This function adds Payload Marker indicating beginning of the payload to the CoAP header. * - * @param[inout] aMessage A pointer to the CoAP message. + * @param[in,out] aMessage A pointer to the CoAP message. * * @retval OT_ERROR_NONE Payload Marker successfully added. * @retval OT_ERROR_NO_BUFS Header Payload Marker exceeds the buffer size. @@ -720,8 +720,8 @@ otCoapCode otCoapMessageGetCode(const otMessage *aMessage); /** * This function sets the Code value. * - * @param[inout] aMessage A pointer to the CoAP message to initialize. - * @param[in] aCode CoAP message code. + * @param[in,out] aMessage A pointer to the CoAP message to initialize. + * @param[in] aCode CoAP message code. * */ void otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode); @@ -769,8 +769,8 @@ const uint8_t *otCoapMessageGetToken(const otMessage *aMessage); /** * This function initialises an iterator for the options in the given message. * - * @param[inout] aIterator A pointer to the CoAP message option iterator. - * @param[in] aMessage A pointer to the CoAP message. + * @param[in,out] aIterator A pointer to the CoAP message option iterator. + * @param[in] aMessage A pointer to the CoAP message. * * @retval OT_ERROR_NONE Successfully initialised. * @retval OT_ERROR_PARSE Message state is inconsistent. @@ -792,7 +792,7 @@ const otCoapOption *otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionItera /** * This function returns a pointer to the first option. * - * @param[inout] aIterator A pointer to the CoAP message option iterator. + * @param[in,out] aIterator A pointer to the CoAP message option iterator. * * @returns A pointer to the first option. If no option is present NULL pointer is returned. * @@ -813,7 +813,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterat /** * This function returns a pointer to the next option. * - * @param[inout] aIterator A pointer to the CoAP message option iterator. + * @param[in,out] aIterator A pointer to the CoAP message option iterator. * * @returns A pointer to the next option. If no more options are present NULL pointer is returned. * @@ -824,7 +824,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIte * This function fills current option value into @p aValue assuming the current value is an unsigned integer encoded * according to https://tools.ietf.org/html/rfc7252#section-3.2 * - * @param[inout] aIterator A pointer to the CoAP message option iterator. + * @param[in,out] aIterator A pointer to the CoAP message option iterator. * @param[out] aValue A pointer to an unsigned integer to receive the option value. * * @retval OT_ERROR_NONE Successfully filled value. @@ -838,8 +838,8 @@ otError otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, /** * This function fills current option value into @p aValue. * - * @param[inout] aIterator A pointer to the CoAP message option iterator. - * @param[out] aValue A pointer to a buffer to receive the option value. + * @param[in,out] aIterator A pointer to the CoAP message option iterator. + * @param[out] aValue A pointer to a buffer to receive the option value. * * @retval OT_ERROR_NONE Successfully filled value. * @retval OT_ERROR_NOT_FOUND No current option. diff --git a/include/openthread/commissioner.h b/include/openthread/commissioner.h index f142edcb0..fc762f280 100644 --- a/include/openthread/commissioner.h +++ b/include/openthread/commissioner.h @@ -251,7 +251,7 @@ otError otCommissionerAddJoinerWithDiscerner(otInstance * aInstance, * This method get joiner info at aIterator position. * * @param[in] aInstance A pointer to instance. - * @param[inout] aIterator A pointer to the Joiner Info iterator context. + * @param[in,out] aIterator A pointer to the Joiner Info iterator context. * @param[out] aJoiner A reference to Joiner info. * * @retval OT_ERROR_NONE Successfully get the Joiner info. diff --git a/include/openthread/crypto.h b/include/openthread/crypto.h index a1a3d36ae..3be657bca 100644 --- a/include/openthread/crypto.h +++ b/include/openthread/crypto.h @@ -89,20 +89,20 @@ void otCryptoHmacSha256(const otCryptoKey *aKey, const uint8_t *aBuf, uint16_t a /** * This method performs AES CCM computation. * - * @param[in] aKey A pointer to the key. - * @param[in] aTagLength Length of tag in bytes. - * @param[in] aNonce A pointer to the nonce. - * @param[in] aNonceLength Length of nonce in bytes. + * @param[in] aKey A pointer to the key. + * @param[in] aTagLength Length of tag in bytes. + * @param[in] aNonce A pointer to the nonce. + * @param[in] aNonceLength Length of nonce in bytes. * - * @param[in] aHeader A pointer to the header. - * @param[in] aHeaderLength Length of header in bytes. + * @param[in] aHeader A pointer to the header. + * @param[in] aHeaderLength Length of header in bytes. * - * @param[inout] aPlainText A pointer to the plaintext. - * @param[inout] aCipherText A pointer to the ciphertext. - * @param[in] aLength Plaintext length in bytes. - * @param[in] aEncrypt `true` on encrypt and `false` on decrypt. + * @param[in,out] aPlainText A pointer to the plaintext. + * @param[in,out] aCipherText A pointer to the ciphertext. + * @param[in] aLength Plaintext length in bytes. + * @param[in] aEncrypt `true` on encrypt and `false` on decrypt. * - * @param[out] aTag A pointer to the tag. + * @param[out] aTag A pointer to the tag. * */ void otCryptoAesCcm(const otCryptoKey *aKey, @@ -120,12 +120,12 @@ void otCryptoAesCcm(const otCryptoKey *aKey, /** * This method creates ECDSA sign. * - * @param[out] aOutput An output buffer where ECDSA sign should be stored. - * @param[inout] aOutputLength The length of the @p aOutput buffer. - * @param[in] aInputHash An input hash. - * @param[in] aInputHashLength The length of the @p aInputHash buffer. - * @param[in] aPrivateKey A private key in PEM format. - * @param[in] aPrivateKeyLength The length of the @p aPrivateKey buffer. + * @param[out] aOutput An output buffer where ECDSA sign should be stored. + * @param[in,out] aOutputLength The length of the @p aOutput buffer. + * @param[in] aInputHash An input hash. + * @param[in] aInputHashLength The length of the @p aInputHash buffer. + * @param[in] aPrivateKey A private key in PEM format. + * @param[in] aPrivateKeyLength The length of the @p aPrivateKey buffer. * * @retval OT_ERROR_NONE ECDSA sign has been created successfully. * @retval OT_ERROR_NO_BUFS Output buffer is too small. diff --git a/include/openthread/history_tracker.h b/include/openthread/history_tracker.h index dfb098f27..a8dc7c301 100644 --- a/include/openthread/history_tracker.h +++ b/include/openthread/history_tracker.h @@ -241,12 +241,12 @@ void otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator); /** * This function iterates over the entries in the network info history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries - * older than max age. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries + * older than max age. * * @returns A pointer to `otHistoryTrackerNetworkInfo` entry or `NULL` if no more entries in the list. * @@ -258,9 +258,9 @@ const otHistoryTrackerNetworkInfo *otHistoryTrackerIterateNetInfoHistory(otInsta /** * This function iterates over the entries in the unicast address history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -276,9 +276,9 @@ const otHistoryTrackerUnicastAddressInfo *otHistoryTrackerIterateUnicastAddressH /** * This function iterates over the entries in the multicast address history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -294,9 +294,9 @@ const otHistoryTrackerMulticastAddressInfo *otHistoryTrackerIterateMulticastAddr /** * This function iterates over the entries in the RX message history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -311,9 +311,9 @@ const otHistoryTrackerMessageInfo *otHistoryTrackerIterateRxHistory(otInstance * /** * This function iterates over the entries in the TX message history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -328,9 +328,9 @@ const otHistoryTrackerMessageInfo *otHistoryTrackerIterateTxHistory(otInstance * /** * This function iterates over the entries in the neighbor history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -345,9 +345,9 @@ const otHistoryTrackerNeighborInfo *otHistoryTrackerIterateNeighborHistory(otIns /** * This function iterates over the entries in the Network Data on mesh prefix entry history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. @@ -362,9 +362,9 @@ const otHistoryTrackerOnMeshPrefixInfo *otHistoryTrackerIterateOnMeshPrefixHisto /** * This function iterates over the entries in the Network Data external route entry history list. * - * @param[in] aInstance A pointer to the OpenThread instance. - * @param[inout] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. - * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. + * @param[in] aInstance A pointer to the OpenThread instance. + * @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. + * @param[out] aEntryAge A pointer to a variable to output the entry's age. MUST NOT be NULL. * Age is provided as the duration (in milliseconds) from when entry was recorded to * @p aIterator initialization time. It is set to `OT_HISTORY_TRACKER_MAX_AGE` for entries * older than max age. diff --git a/include/openthread/instance.h b/include/openthread/instance.h index c575f06f0..7795fb686 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -78,9 +78,9 @@ typedef struct otInstance otInstance; * * This function is available and can only be used when support for multiple OpenThread instances is enabled. * - * @param[in] aInstanceBuffer The buffer for OpenThread to use for allocating the otInstance structure. - * @param[inout] aInstanceBufferSize On input, the size of aInstanceBuffer. On output, if not enough space for - * otInstance, the number of bytes required for otInstance. + * @param[in] aInstanceBuffer The buffer for OpenThread to use for allocating the otInstance structure. + * @param[in,out] aInstanceBufferSize On input, the size of aInstanceBuffer. On output, if not enough space for + * otInstance, the number of bytes required for otInstance. * * @returns A pointer to the new OpenThread instance. * diff --git a/include/openthread/ip6.h b/include/openthread/ip6.h index 4a7d797ec..a055acf87 100644 --- a/include/openthread/ip6.h +++ b/include/openthread/ip6.h @@ -693,8 +693,8 @@ bool otIp6IsAddressUnspecified(const otIp6Address *aAddress); /** * This function perform OpenThread source address selection. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aMessageInfo A pointer to the message information. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aMessageInfo A pointer to the message information. * * @retval OT_ERROR_NONE Found a source address and is filled into mSockAddr of @p aMessageInfo. * @retval OT_ERROR_NOT_FOUND No source address was found and @p aMessageInfo is unchanged. diff --git a/include/openthread/link.h b/include/openthread/link.h index 719ee371b..0a06150ad 100644 --- a/include/openthread/link.h +++ b/include/openthread/link.h @@ -773,10 +773,10 @@ void otLinkFilterClearAddresses(otInstance *aInstance); * * This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the MAC filter iterator context. To get the first in-use address filter entry, - * it should be set to OT_MAC_FILTER_ITERATOR_INIT. MUST NOT be NULL. - * @param[out] aEntry A pointer to where the information is placed. MUST NOT be NULL. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the MAC filter iterator context. To get the first in-use address filter + * entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. MUST NOT be NULL. + * @param[out] aEntry A pointer to where the information is placed. MUST NOT be NULL. * * @retval OT_ERROR_NONE Successfully retrieved an in-use address filter entry. * @retval OT_ERROR_NOT_FOUND No subsequent entry exists. @@ -852,12 +852,12 @@ void otLinkFilterClearAllRssIn(otInstance *aInstance); * * This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the MAC filter iterator context. MUST NOT be NULL. - * To get the first entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. - * @param[out] aEntry A pointer to where the information is placed. The last entry would have the extended - * address as all 0xff to indicate the default received signal strength if it was set. - @p aEntry MUST NOT be NULL. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the MAC filter iterator context. MUST NOT be NULL. + * To get the first entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. + * @param[out] aEntry A pointer to where the information is placed. The last entry would have the extended + * address as all 0xff to indicate the default received signal strength if it was set. + @p aEntry MUST NOT be NULL. * * @retval OT_ERROR_NONE Successfully retrieved the next entry. * @retval OT_ERROR_NOT_FOUND No subsequent entry exists. diff --git a/include/openthread/netdata.h b/include/openthread/netdata.h index f67ea9bec..90f2e646f 100644 --- a/include/openthread/netdata.h +++ b/include/openthread/netdata.h @@ -127,11 +127,11 @@ typedef struct otServiceConfig /** * This method provides a full or stable copy of the Partition's Thread Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. - * @param[out] aData A pointer to the data buffer. - * @param[inout] aDataLength On entry, size of the data buffer pointed to by @p aData. - * On exit, number of copied bytes. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. + * @param[out] aData A pointer to the data buffer. + * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. + * On exit, number of copied bytes. * */ otError otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength); @@ -139,10 +139,10 @@ otError otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_ /** * This function gets the next On Mesh Prefix in the partition's Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first on-mesh entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to where the On Mesh Prefix information will be placed. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first on-mesh entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to where the On Mesh Prefix information will be placed. * * @retval OT_ERROR_NONE Successfully found the next On Mesh prefix. * @retval OT_ERROR_NOT_FOUND No subsequent On Mesh prefix exists in the Thread Network Data. @@ -155,10 +155,10 @@ otError otNetDataGetNextOnMeshPrefix(otInstance * aInstance, /** * This function gets the next external route in the partition's Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first external route entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to where the External Route information will be placed. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first external route entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to where the External Route information will be placed. * * @retval OT_ERROR_NONE Successfully found the next External Route. * @retval OT_ERROR_NOT_FOUND No subsequent external route entry exists in the Thread Network Data. @@ -169,10 +169,10 @@ otError otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIte /** * This function gets the next service in the partition's Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first service entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to where the service information will be placed. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first service entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to where the service information will be placed. * * @retval OT_ERROR_NONE Successfully found the next service. * @retval OT_ERROR_NOT_FOUND No subsequent service exists in the partition's Network Data. diff --git a/include/openthread/netdiag.h b/include/openthread/netdiag.h index 2d291a080..d40238340 100644 --- a/include/openthread/netdiag.h +++ b/include/openthread/netdiag.h @@ -264,10 +264,10 @@ typedef struct otNetworkDiagTlv /** * This function gets the next Network Diagnostic TLV in the message. * - * @param[in] aMessage A pointer to a message. - * @param[inout] aIterator A pointer to the Network Diagnostic iterator context. To get the first - * Network Diagnostic TLV it should be set to OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT. - * @param[out] aNetworkDiagTlv A pointer to where the Network Diagnostic TLV information will be placed. + * @param[in] aMessage A pointer to a message. + * @param[in,out] aIterator A pointer to the Network Diagnostic iterator context. To get the first + * Network Diagnostic TLV it should be set to OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT. + * @param[out] aNetworkDiagTlv A pointer to where the Network Diagnostic TLV information will be placed. * * @retval OT_ERROR_NONE Successfully found the next Network Diagnostic TLV. * @retval OT_ERROR_NOT_FOUND No subsequent Network Diagnostic TLV exists in the message. diff --git a/include/openthread/network_time.h b/include/openthread/network_time.h index 23ab7e207..5e7723173 100644 --- a/include/openthread/network_time.h +++ b/include/openthread/network_time.h @@ -78,8 +78,8 @@ typedef void (*otNetworkTimeSyncCallbackFn)(void *aCallbackContext); /** * Get the Thread network time. * - * @param[in] aInstance The OpenThread instance structure. - * @param[inout] aNetworkTime The Thread network time in microseconds. + * @param[in] aInstance The OpenThread instance structure. + * @param[in,out] aNetworkTime The Thread network time in microseconds. * * @returns The time synchronization status. * diff --git a/include/openthread/platform/crypto.h b/include/openthread/platform/crypto.h index 0d9bf5ca3..a05eb1ab4 100644 --- a/include/openthread/platform/crypto.h +++ b/include/openthread/platform/crypto.h @@ -139,13 +139,13 @@ void otPlatCryptoInit(void); /** * Import a key into PSA ITS. * - * @param[inout] aKeyRef Pointer to the key ref to be used for crypto operations. - * @param[in] aKeyType Key Type encoding for the key. - * @param[in] aKeyAlgorithm Key algorithm encoding for the key. - * @param[in] aKeyUsage Key Usage encoding for the key (combinations of `OT_CRYPTO_KEY_USAGE_*`). - * @param[in] aKeyPersistence Key Persistence for this key - * @param[in] aKey Actual key to be imported. - * @param[in] aKeyLen Length of the key to be imported. + * @param[in,out] aKeyRef Pointer to the key ref to be used for crypto operations. + * @param[in] aKeyType Key Type encoding for the key. + * @param[in] aKeyAlgorithm Key algorithm encoding for the key. + * @param[in] aKeyUsage Key Usage encoding for the key (combinations of `OT_CRYPTO_KEY_USAGE_*`). + * @param[in] aKeyPersistence Key Persistence for this key + * @param[in] aKey Actual key to be imported. + * @param[in] aKeyLen Length of the key to be imported. * * @retval OT_ERROR_NONE Successfully imported the key. * @retval OT_ERROR_FAILED Failed to import the key. diff --git a/include/openthread/platform/settings.h b/include/openthread/platform/settings.h index b93a15d10..8d0b2516b 100644 --- a/include/openthread/platform/settings.h +++ b/include/openthread/platform/settings.h @@ -123,15 +123,15 @@ void otPlatSettingsSetCriticalKeys(otInstance *aInstance, const uint16_t *aKeys, * values. The order of such values MAY change after ANY * write operation to the store. * - * @param[in] aInstance The OpenThread instance structure. - * @param[in] aKey The key associated with the requested setting. - * @param[in] aIndex The index of the specific item to get. - * @param[out] aValue A pointer to where the value of the setting should be written. May be set to NULL if - * just testing for the presence or length of a setting. - * @param[inout] aValueLength A pointer to the length of the value. When called, this pointer should point to an - * integer containing the maximum value size that can be written to aValue. At return, - * the actual length of the setting is written. This may be set to NULL if performing - * a presence check. + * @param[in] aInstance The OpenThread instance structure. + * @param[in] aKey The key associated with the requested setting. + * @param[in] aIndex The index of the specific item to get. + * @param[out] aValue A pointer to where the value of the setting should be written. May be set to NULL if + * just testing for the presence or length of a setting. + * @param[in,out] aValueLength A pointer to the length of the value. When called, this pointer should point to an + * integer containing the maximum value size that can be written to aValue. At return, + * the actual length of the setting is written. This may be set to NULL if performing + * a presence check. * * @retval OT_ERROR_NONE The given setting was found and fetched successfully. * @retval OT_ERROR_NOT_FOUND The given setting was not found in the setting store. diff --git a/include/openthread/server.h b/include/openthread/server.h index 05f32056d..0d177c701 100644 --- a/include/openthread/server.h +++ b/include/openthread/server.h @@ -54,11 +54,11 @@ extern "C" { /** * This method provides a full or stable copy of the local Thread Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. - * @param[out] aData A pointer to the data buffer. - * @param[inout] aDataLength On entry, size of the data buffer pointed to by @p aData. - * On exit, number of copied bytes. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. + * @param[out] aData A pointer to the data buffer. + * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. + * On exit, number of copied bytes. * */ otError otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength); @@ -102,10 +102,10 @@ otError otServerRemoveService(otInstance * aInstance, /** * This function gets the next service in the local Network Data. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the Network Data iterator context. To get the first service entry - it should be set to OT_NETWORK_DATA_ITERATOR_INIT. - * @param[out] aConfig A pointer to where the service information will be placed. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first service entry + it should be set to OT_NETWORK_DATA_ITERATOR_INIT. + * @param[out] aConfig A pointer to where the service information will be placed. * * @retval OT_ERROR_NONE Successfully found the next service. * @retval OT_ERROR_NOT_FOUND No subsequent service exists in the Thread Network Data. diff --git a/include/openthread/thread.h b/include/openthread/thread.h index b23bd6669..183b4fff8 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -714,10 +714,10 @@ otError otThreadBecomeChild(otInstance *aInstance); * This function gets the next neighbor information. It is used to go through the entries of * the neighbor table. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[inout] aIterator A pointer to the iterator context. To get the first neighbor entry - it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT. - * @param[out] aInfo A pointer to the neighbor information. + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in,out] aIterator A pointer to the iterator context. To get the first neighbor entry + it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT. + * @param[out] aInfo A pointer to the neighbor information. * * @retval OT_ERROR_NONE Successfully found the next neighbor entry in table. * @retval OT_ERROR_NOT_FOUND No subsequent neighbor entry exists in the table. diff --git a/include/openthread/thread_ftd.h b/include/openthread/thread_ftd.h index c54ea74e7..31421890f 100644 --- a/include/openthread/thread_ftd.h +++ b/include/openthread/thread_ftd.h @@ -484,12 +484,12 @@ otError otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, /** * This function gets the next IPv6 address (using an iterator) for a given child. * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aChildIndex The child index. - * @param[inout] aIterator A pointer to the iterator. On success the iterator will be updated to point to next - * entry in the list. To get the first IPv6 address the iterator should be set to - * OT_CHILD_IP6_ADDRESS_ITERATOR_INIT. - * @param[out] aAddress A pointer to an IPv6 address where the child's next address is placed (on success). + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[in] aChildIndex The child index. + * @param[in,out] aIterator A pointer to the iterator. On success the iterator will be updated to point to next + * entry in the list. To get the first IPv6 address the iterator should be set to + * OT_CHILD_IP6_ADDRESS_ITERATOR_INIT. + * @param[out] aAddress A pointer to an IPv6 address where the child's next address is placed (on success). * * @retval OT_ERROR_NONE Successfully found the next IPv6 address (@p aAddress was successfully updated). * @retval OT_ERROR_NOT_FOUND The child has no subsequent IPv6 address entry. @@ -540,11 +540,11 @@ otError otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRoute /** * This function gets the next EID cache entry (using an iterator). * - * @param[in] aInstance A pointer to an OpenThread instance. - * @param[out] aEntryInfo A pointer to where the EID cache entry information is placed. - * @param[inout] aIterator A pointer to an iterator. It will be updated to point to next entry on success. To get the - * first entry, initialize the iterator by setting all its fields to zero (e.g., `memset` the - * the iterator structure to zero). + * @param[in] aInstance A pointer to an OpenThread instance. + * @param[out] aEntryInfo A pointer to where the EID cache entry information is placed. + * @param[in,out] aIterator A pointer to an iterator. It will be updated to point to next entry on success. To get + * the first entry, initialize the iterator by setting all its fields to zero + * (e.g., `memset` the iterator structure to zero). * * @retval OT_ERROR_NONE Successfully populated @p aEntryInfo for next EID cache entry. * @retval OT_ERROR_NOT_FOUND No more entries in the address cache table. diff --git a/src/core/common/instance.hpp b/src/core/common/instance.hpp index 5706cf2f0..4daa0ae2b 100644 --- a/src/core/common/instance.hpp +++ b/src/core/common/instance.hpp @@ -119,9 +119,9 @@ public: * * This function must be called before any other calls on OpenThread instance. * - * @param[in] aBuffer The buffer for OpenThread to use for allocating the Instance. - * @param[inout] aBufferSize On input, the size of `aBuffer`. On output, if not enough space for `Instance`, the - number of bytes required for `Instance`. + * @param[in] aBuffer The buffer for OpenThread to use for allocating the Instance. + * @param[in,out] aBufferSize On input, the size of `aBuffer`. On output, if not enough space for `Instance`, the + number of bytes required for `Instance`. * * @returns A pointer to the new OpenThread instance. * diff --git a/src/core/common/notifier.hpp b/src/core/common/notifier.hpp index 96494ac1a..e0b7f1dd0 100644 --- a/src/core/common/notifier.hpp +++ b/src/core/common/notifier.hpp @@ -270,9 +270,9 @@ public: * * The template `Type` should support comparison operator `==` and assignment operator `=`. * - * @param[inout] aVariable A reference to the variable to update. - * @param[in] aNewValue The new value. - * @param[in] aEvent The event to signal. + * @param[in,out] aVariable A reference to the variable to update. + * @param[in] aNewValue The new value. + * @param[in] aEvent The event to signal. * * @retval kErrorNone The variable was update successfully and @p aEvent was signaled. * @retval kErrorAlready The variable was already set to the same value. diff --git a/src/core/common/settings_driver.hpp b/src/core/common/settings_driver.hpp index 6650dccfa..29a13aa31 100644 --- a/src/core/common/settings_driver.hpp +++ b/src/core/common/settings_driver.hpp @@ -155,15 +155,15 @@ public: /** * This method fetches the value identified by @p aKey at a given @p aIndex. * - * @param[in] aKey The key associated with the requested value. - * @param[in] aIndex The index of the specific item to get. - * @param[out] aValue A pointer to where the value of the setting should be written. - * May be `nullptr` if just testing for the presence or length of a key. - * @param[inout] aValueLength A pointer to the length of the value. - * When called, this should point to an integer containing the maximum bytes that - * can be written to @p aValue. - * At return, the actual length of the setting is written. - * May be `nullptr` if performing a presence check. + * @param[in] aKey The key associated with the requested value. + * @param[in] aIndex The index of the specific item to get. + * @param[out] aValue A pointer to where the value of the setting should be written. + * May be `nullptr` if just testing for the presence or length of a key. + * @param[in,out] aValueLength A pointer to the length of the value. + * When called, this should point to an integer containing the maximum bytes that + * can be written to @p aValue. + * At return, the actual length of the setting is written. + * May be `nullptr` if performing a presence check. * * @retval kErrorNone The value was fetched successfully. * @retval kErrorNotFound The key was not found. @@ -185,14 +185,14 @@ public: /** * This method fetches the value identified by @p aKey. * - * @param[in] aKey The key associated with the requested value. - * @param[out] aValue A pointer to where the value of the setting should be written. - * May be `nullptr` if just testing for the presence or length of a key. - * @param[inout] aValueLength A pointer to the length of the value. - * When called, this should point to an integer containing the maximum bytes that - * can be written to @p aValue. - * At return, the actual length of the setting is written. - * May be `nullptr` if performing a presence check. + * @param[in] aKey The key associated with the requested value. + * @param[out] aValue A pointer to where the value of the setting should be written. + * May be `nullptr` if just testing for the presence or length of a key. + * @param[in,out] aValueLength A pointer to the length of the value. + * When called, this should point to an integer containing the maximum bytes that + * can be written to @p aValue. + * At return, the actual length of the setting is written. + * May be `nullptr` if performing a presence check. * * @retval kErrorNone The value was fetched successfully. * @retval kErrorNotFound The key was not found. diff --git a/src/core/common/string.hpp b/src/core/common/string.hpp index 6a5160031..a2ab1aa85 100644 --- a/src/core/common/string.hpp +++ b/src/core/common/string.hpp @@ -158,7 +158,7 @@ bool StringMatch(const char *aFirstString, const char *aSecondString, StringMatc /** * This function converts all uppercase letter characters in a given string to lowercase. * - * @param[inout] aString A pointer to the string to convert. + * @param[in,out] aString A pointer to the string to convert. * */ void StringConvertToLowercase(char *aString); @@ -166,7 +166,7 @@ void StringConvertToLowercase(char *aString); /** * This function converts all lowercase letter characters in a given string to uppercase. * - * @param[inout] aString A pointer to the string to convert. + * @param[in,out] aString A pointer to the string to convert. * */ void StringConvertToUppercase(char *aString); diff --git a/src/core/common/uptime.hpp b/src/core/common/uptime.hpp index f1215bccd..d6cab3ce2 100644 --- a/src/core/common/uptime.hpp +++ b/src/core/common/uptime.hpp @@ -92,8 +92,8 @@ public: * The string follows the format "::." for hours, minutes, seconds and millisecond (if uptime is * shorter than one day) or "
d.::." (if longer than a day). * - * @param[in] aUptime The uptime to convert. - * @param[inout] aWriter A `StringWriter` to append the converted string to. + * @param[in] aUptime The uptime to convert. + * @param[in,out] aWriter A `StringWriter` to append the converted string to. * */ static void UptimeToString(uint64_t aUptime, StringWriter &aWriter); diff --git a/src/core/crypto/aes_ccm.hpp b/src/core/crypto/aes_ccm.hpp index 34e50f721..fcca7fc5d 100644 --- a/src/core/crypto/aes_ccm.hpp +++ b/src/core/crypto/aes_ccm.hpp @@ -128,10 +128,10 @@ public: /** * This method processes the payload. * - * @param[inout] aPlainText A pointer to the plaintext. - * @param[inout] aCipherText A pointer to the ciphertext. - * @param[in] aLength Payload length in bytes. - * @param[in] aMode Mode to indicate whether to encrypt (`kEncrypt`) or decrypt (`kDecrypt`). + * @param[in,out] aPlainText A pointer to the plaintext. + * @param[in,out] aCipherText A pointer to the ciphertext. + * @param[in] aLength Payload length in bytes. + * @param[in] aMode Mode to indicate whether to encrypt (`kEncrypt`) or decrypt (`kDecrypt`). * */ void Payload(void *aPlainText, void *aCipherText, uint32_t aLength, Mode aMode); diff --git a/src/core/crypto/ecdsa.hpp b/src/core/crypto/ecdsa.hpp index 6f9d9b3dd..98b439b81 100644 --- a/src/core/crypto/ecdsa.hpp +++ b/src/core/crypto/ecdsa.hpp @@ -265,12 +265,12 @@ public: /** * This function creates an ECDSA signature. * - * @param[out] aOutput An output buffer where ECDSA sign should be stored. - * @param[inout] aOutputLength The length of the @p aOutput buffer. - * @param[in] aInputHash An input hash. - * @param[in] aInputHashLength The length of the @p aInputHash buffer. - * @param[in] aPrivateKey A private key in PEM format. - * @param[in] aPrivateKeyLength The length of the @p aPrivateKey buffer. + * @param[out] aOutput An output buffer where ECDSA sign should be stored. + * @param[in,out] aOutputLength The length of the @p aOutput buffer. + * @param[in] aInputHash An input hash. + * @param[in] aInputHashLength The length of the @p aInputHash buffer. + * @param[in] aPrivateKey A private key in PEM format. + * @param[in] aPrivateKeyLength The length of the @p aPrivateKey buffer. * * @retval kErrorNone ECDSA sign has been created successfully. * @retval kErrorNoBufs Output buffer is too small. diff --git a/src/core/crypto/storage.hpp b/src/core/crypto/storage.hpp index fd2273a2a..725ab2755 100644 --- a/src/core/crypto/storage.hpp +++ b/src/core/crypto/storage.hpp @@ -120,13 +120,13 @@ inline bool IsKeyRefValid(KeyRef aKeyRef) /** * Import a key into PSA ITS. * - * @param[inout] aKeyRef Reference to the key ref to be used for crypto operations. - * @param[in] aKeyType Key Type encoding for the key. - * @param[in] aKeyAlgorithm Key algorithm encoding for the key. - * @param[in] aKeyUsage Key Usage encoding for the key. - * @param[in] aStorageType Key storage type. - * @param[in] aKey Actual key to be imported. - * @param[in] aKeyLen Length of the key to be imported. + * @param[in,out] aKeyRef Reference to the key ref to be used for crypto operations. + * @param[in] aKeyType Key Type encoding for the key. + * @param[in] aKeyAlgorithm Key algorithm encoding for the key. + * @param[in] aKeyUsage Key Usage encoding for the key. + * @param[in] aStorageType Key storage type. + * @param[in] aKey Actual key to be imported. + * @param[in] aKeyLen Length of the key to be imported. * * @retval kErrorNone Successfully imported the key. * @retval kErrorFailed Failed to import the key. @@ -280,9 +280,9 @@ public: * * This method MUST be used when `IsKeyRef()` returns `true`. * - * @param[out] aKeyBuffer Pointer to a byte array buffer to place the extracted key. - * @param[inout] aKeyLength On input, the size of @p aKeyBuffer. - * On exit, returns the key length (number of bytes written in @p aKeyBuffer). + * @param[out] aKeyBuffer Pointer to a byte array buffer to place the extracted key. + * @param[in,out] aKeyLength On input, the size of @p aKeyBuffer. + * On exit, returns the key length (number of bytes written in @p aKeyBuffer). * * @retval kErrorNone Successfully extracted the key, @p aKeyBuffer and @p aKeyLength are updated. * @retval kErrorNoBufs Key does not fit in @p aKeyBuffer (extracted key length is larger than @p aKeyLength). diff --git a/src/core/mac/channel_mask.hpp b/src/core/mac/channel_mask.hpp index e92eca1bb..200ab5b25 100644 --- a/src/core/mac/channel_mask.hpp +++ b/src/core/mac/channel_mask.hpp @@ -200,7 +200,7 @@ public: * This method can be used to iterate over all channels in the channel mask. To get the first channel (channel with * lowest number) in the mask the @p aChannel should be set to `kChannelIteratorFirst`. * - * @param[inout] aChannel A reference to a `uint8_t`. + * @param[in,out] aChannel A reference to a `uint8_t`. * On entry it should contain the previous channel or `kChannelIteratorFirst`. * On exit it contains the next channel. * diff --git a/src/core/mac/mac_filter.hpp b/src/core/mac/mac_filter.hpp index 30bbb4d53..2eaef71aa 100644 --- a/src/core/mac/mac_filter.hpp +++ b/src/core/mac/mac_filter.hpp @@ -140,9 +140,9 @@ public: /** * This method iterates through filter entries. * - * @param[inout] aIterator A reference to the MAC filter iterator context. - * To get the first in-use address filter, set it to OT_MAC_FILTER_ITERATOR_INIT. - * @param[out] aEntry A reference to where the information is placed. + * @param[in,out] aIterator A reference to the MAC filter iterator context. + * To get the first in-use address filter, set it to OT_MAC_FILTER_ITERATOR_INIT. + * @param[out] aEntry A reference to where the information is placed. * * @retval kErrorNone Successfully retrieved the next address filter entry. * @retval kErrorNotFound No subsequent entry exists. @@ -198,11 +198,11 @@ public: /** * This method iterates through RssIn filter entry. * - * @param[inout] aIterator A reference to the MAC filter iterator context. To get the first in-use RssIn - * filter entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. - * @param[out] aEntry A reference to where the information is placed. The last entry would have the - * Extended Address as all 0xff to indicate the default received signal strength - * if it was set. + * @param[in,out] aIterator A reference to the MAC filter iterator context. To get the first in-use RssIn + * filter entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. + * @param[out] aEntry A reference to where the information is placed. The last entry would have the + * Extended Address as all 0xff to indicate the default received signal strength + * if it was set. * * @retval kErrorNone Successfully retrieved the next RssIn filter entry. * @retval kErrorNotFound No subsequent entry exists. diff --git a/src/core/meshcop/commissioner.hpp b/src/core/meshcop/commissioner.hpp index c396aeb6b..90639e99b 100644 --- a/src/core/meshcop/commissioner.hpp +++ b/src/core/meshcop/commissioner.hpp @@ -307,7 +307,7 @@ public: /** * This method get joiner info at aIterator position. * - * @param[inout] aIterator A iterator to the index of the joiner. + * @param[in,out] aIterator A iterator to the index of the joiner. * @param[out] aJoiner A reference to Joiner info. * * @retval kErrorNone Successfully get the Joiner info. diff --git a/src/core/net/checksum.hpp b/src/core/net/checksum.hpp index e56dc2f77..311ba6da8 100644 --- a/src/core/net/checksum.hpp +++ b/src/core/net/checksum.hpp @@ -71,7 +71,7 @@ public: /** * This static method calculates and then updates the checksum in a given message (if UDP/ICMP6). * - * @param[inout] aMessage The message to update the checksum in. The `aMessage.GetOffset()` should point to start + * @param[in,out] aMessage The message to update the checksum in. The `aMessage.GetOffset()` should point to start * of the UDP/ICMP6 header. On exit the checksum field in UDP/ICMP6 header in the message * is updated. * @param[in] aSource The source address. diff --git a/src/core/net/dns_types.hpp b/src/core/net/dns_types.hpp index 4b2817ee6..db447aa83 100644 --- a/src/core/net/dns_types.hpp +++ b/src/core/net/dns_types.hpp @@ -805,9 +805,9 @@ public: /** * This static method parses and skips over a full name in a message. * - * @param[in] aMessage The message to parse the name from. `aMessage.GetOffset()` MUST point to + * @param[in] aMessage The message to parse the name from. `aMessage.GetOffset()` MUST point to * the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input the offset in @p aMessage pointing to the start of the name field. + * @param[in,out] aOffset On input the offset in @p aMessage pointing to the start of the name field. * On exit (when parsed successfully), @p aOffset is updated to point to the byte * after the end of name field. * @@ -829,13 +829,13 @@ public: * Unlike `ReadName()` which requires and verifies that the read label to contain no dot '.' character, this method * allows the read label to include any character. * - * @param[in] aMessage The message to read the label from. `aMessage.GetOffset()` MUST point to + * @param[in] aMessage The message to read the label from. `aMessage.GetOffset()` MUST point to * the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the label to read. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the label to read. * On exit, when successfully read, @p aOffset is updated to point to the start of * the next label. - * @param[out] aLabelBuffer A pointer to a char array to output the read label as a null-terminated C string. - * @param[inout] aLabelLength On input, the maximum number chars in @p aLabelBuffer array. + * @param[out] aLabelBuffer A pointer to a char array to output the read label as a null-terminated C string. + * @param[in,out] aLabelLength On input, the maximum number chars in @p aLabelBuffer array. * On output, when label is successfully read, @p aLabelLength is updated to return * the label's length (number of chars in the label string, excluding the null char). * @@ -856,13 +856,13 @@ public: * This method verifies that the read labels in message do not contain any dot character, otherwise it returns * `kErrorParse`). * - * @param[in] aMessage The message to read the name from. `aMessage.GetOffset()` MUST point to - * the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the name field. - * On exit (when parsed successfully), @p aOffset is updated to point to the byte - * after the end of name field. - * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string. - * @param[inout] aNameBufferSize The maximum number of chars in @p aNameBuffer array. + * @param[in] aMessage The message to read the name from. `aMessage.GetOffset()` MUST point to + * the start of DNS header (this is used to handle compressed names). + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the name field. + * On exit (when parsed successfully), @p aOffset is updated to point to the byte + * after the end of name field. + * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string. + * @param[in,out] aNameBufferSize The maximum number of chars in @p aNameBuffer array. * * @retval kErrorNone Successfully read the name, @p aNameBuffer and @p Offset are updated. * @retval kErrorParse Name could not be parsed (invalid format). @@ -880,12 +880,12 @@ public: * Unlike `CompareName()` which requires the labels in the the name string to contain no dot '.' character, this * method allows @p aLabel to include any character. * - * @param[in] aMessage The message to read the label from to compare. `aMessage.GetOffset()` MUST point + * @param[in] aMessage The message to read the label from to compare. `aMessage.GetOffset()` MUST point * to the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the label to read. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the label to read. * On exit and only when label is successfully read and does match @p aLabel, * @p aOffset is updated to point to the start of the next label. - * @param[in] aLabel A pointer to a null terminated string containing the label to compare with. + * @param[in] aLabel A pointer to a null terminated string containing the label to compare with. * * @retval kErrorNone The label from @p aMessage matches @p aLabel. @p aOffset is updated. * @retval kErrorNotFound The label from @p aMessage does not match @p aLabel (note that @p aOffset is not @@ -906,14 +906,14 @@ public: * The @p aName must follow "..", i.e., a sequence of labels separated by dot '.' char. * E.g., "example.com", "example.com." (same as previous one), "local.", "default.service.arpa", "." or "" (root). * - * @param[in] aMessage The message to read the name from and compare with @p aName. + * @param[in] aMessage The message to read the name from and compare with @p aName. * `aMessage.GetOffset()` MUST point to the start of DNS header (this is used to * handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the name field. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the name field. * On exit (when parsed successfully independent of whether the read name matches * @p aName or not), @p aOffset is updated to point to the byte after the end of * the name field. - * @param[in] aName A pointer to a null terminated string containing the name to compare with. + * @param[in] aName A pointer to a null terminated string containing the name to compare with. * * @retval kErrorNone The name from @p aMessage matches @p aName. @p aOffset is updated. * @retval kErrorNotFound The name from @p aMessage does not match @p aName. @p aOffset is updated. @@ -938,15 +938,15 @@ public: * If the name in @p aMessage can be parsed fully (independent of whether the name matches or not with the name * from @p aMessage2), the @p aOffset is updated (note that @p aOffset2 for @p aMessage2 is not changed). * - * @param[in] aMessage The message to read the name from and compare. `aMessage.GetOffset()` MUST point + * @param[in] aMessage The message to read the name from and compare. `aMessage.GetOffset()` MUST point * to the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the name field. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the name field. * On exit (when parsed successfully independent of whether the read name matches * or not), @p aOffset is updated to point to the byte after the end of the name * field. - * @param[in] aMessage2 The second message to read the name from and compare with name from @p aMessage. + * @param[in] aMessage2 The second message to read the name from and compare with name from @p aMessage. * `aMessage2.GetOffset()` MUST point to the start of DNS header. - * @param[in] aOffset2 The offset in @p aMessage2 pointing to the start of the name field. + * @param[in] aOffset2 The offset in @p aMessage2 pointing to the start of the name field. * * @retval kErrorNone The name from @p aMessage matches the name from @p aMessage2. @p aOffset is updated. * @retval kErrorNotFound The name from @p aMessage does not match the name from @p aMessage2. @p aOffset is @@ -962,13 +962,13 @@ public: * * If @p aName is empty (not specified), then any name in @p aMessage is considered a match to it. * - * @param[in] aMessage The message to read the name from and compare. `aMessage.GetOffset()` MUST point + * @param[in] aMessage The message to read the name from and compare. `aMessage.GetOffset()` MUST point * to the start of DNS header (this is used to handle compressed names). - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the name field. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the name field. * On exit (when parsed successfully independent of whether the read name matches * or not), @p aOffset is updated to point to the byte after the end of the name * field. - * @param[in] aName A reference to a name to compare with. + * @param[in] aName A reference to a name to compare with. * * @retval kErrorNone The name from @p aMessage matches @p aName. @p aOffset is updated. * @retval kErrorNotFound The name from @p aMessage does not match @p aName. @p aOffset is updated. @@ -1336,12 +1336,12 @@ public: /** * This static method parses and skips over a given number of resource records in a message from a given offset. * - * @param[in] aMessage The message from which to parse/read the resource records. `aMessage.GetOffset()` - * MUST point to the start of DNS header. - * @param[inout] aOffset On input the offset in @p aMessage pointing to the start of the first record. - * On exit (when parsed successfully), @p aOffset is updated to point to the byte after - * the last parsed record. - * @param[in] aNumRecords Number of resource records to parse. + * @param[in] aMessage The message from which to parse/read the resource records. `aMessage.GetOffset()` + * MUST point to the start of DNS header. + * @param[in,out] aOffset On input the offset in @p aMessage pointing to the start of the first record. + * On exit (when parsed successfully), @p aOffset is updated to point to the byte after + * the last parsed record. + * @param[in] aNumRecords Number of resource records to parse. * * @retval kErrorNone Parsed records successfully. @p aOffset is updated. * @retval kErrorParse Could not parse the records from @p aMessage (e.g., ran out of bytes in @p aMessage). @@ -1352,17 +1352,17 @@ public: /** * This static method searches in a given message to find the first resource record matching a given record name. * - * @param[in] aMessage The message in which to search for a matching resource record. + * @param[in] aMessage The message in which to search for a matching resource record. * `aMessage.GetOffset()` MUST point to the start of DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the first record. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the first record. * On exit, if a matching record is found, @p aOffset is updated to point to the byte * after the record name. * If a matching record could not be found, @p aOffset is updated to point to the byte * after the last record that was checked. - * @param[inout] aNumRecords On input, the maximum number of records to check (starting from @p aOffset). + * @param[in,out] aNumRecords On input, the maximum number of records to check (starting from @p aOffset). * On exit and if a matching record is found, @p aNumRecords is updated to give the * number of remaining records after @p aOffset (excluding the matching record). - * @param[in] aName The record name to match against. + * @param[in] aName The record name to match against. * * @retval kErrorNone A matching record was found. @p aOffset, @p aNumRecords are updated. * @retval kErrorNotFound A matching record could not be found. @p aOffset and @p aNumRecords are updated. @@ -1382,19 +1382,19 @@ public: * to after the last byte read from the message and copied into @p aRecord. This allows the caller to read any * remaining fields in the record data. * - * @tparam RecordType The resource record type (i.e., a sub-class of `ResourceRecord`). + * @tparam RecordType The resource record type (i.e., a sub-class of `ResourceRecord`). * - * @param[in] aMessage The message to search within for matching resource records. + * @param[in] aMessage The message to search within for matching resource records. * `aMessage.GetOffset()` MUST point to the start of DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the start of the first record. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the start of the first record. * On exit and only if a matching record is found, @p aOffset is updated to point to * the last read byte in the record (allowing caller to read any remaining fields in * the record data from the message). - * @param[in] aNumRecords The maximum number of records to check (starting from @p aOffset). - * @param[in] aIndex The matching record index to find. @p aIndex value of zero returns the first + * @param[in] aNumRecords The maximum number of records to check (starting from @p aOffset). + * @param[in] aIndex The matching record index to find. @p aIndex value of zero returns the first * matching record. - * @param[in] aName The record name to match against. - * @param[in] aRecord A reference to a record object to read a matching record into. + * @param[in] aName The record name to match against. + * @param[in] aRecord A reference to a record object to read a matching record into. * If a matching record is found, `sizeof(RecordType)` bytes from @p aMessage are * read and copied into @p aRecord. * @@ -1432,15 +1432,15 @@ public: * example, when reading a SRV record using `SrvRecord` type, @p aOffset would point to after the last field in * `SrvRecord` which is the start of "target host domain name" field. * - * @tparam RecordType The resource record type (i.e., a sub-class of `ResourceRecord`). + * @tparam RecordType The resource record type (i.e., a sub-class of `ResourceRecord`). * - * @param[in] aMessage The message from which to read the record. - * @param[inout] aOffset On input, the offset in @p aMessage pointing to the byte after the record name. + * @param[in] aMessage The message from which to read the record. + * @param[in,out] aOffset On input, the offset in @p aMessage pointing to the byte after the record name. * On exit, if a matching record is read, @p aOffset is updated to point to the last * read byte in the record. * If a matching record could not be read, @p aOffset is updated to point to the byte * after the entire record (skipping over the record). - * @param[out] aRecord A reference to a record to read a matching record into. + * @param[out] aRecord A reference to a record to read a matching record into. * If a matching record is found, `sizeof(RecordType)` bytes from @p aMessage are * read and copied into @p aRecord. * @@ -1559,14 +1559,14 @@ public: * This method also verifies that the CNAME record is well-formed (e.g., the record data length `GetLength()` * matches the CNAME encoded name). * - * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of + * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of * DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage to start of CNAME name field. + * @param[in,out] aOffset On input, the offset in @p aMessage to start of CNAME name field. * On exit when successfully read, @p aOffset is updated to point to the byte * after the entire PTR record (skipping over the record). - * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string + * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string * (MUST NOT be `nullptr`). - * @param[in] aNameBufferSize The size of @p aNameBuffer. + * @param[in] aNameBufferSize The size of @p aNameBuffer. * * @retval kErrorNone The CNAME name was read successfully. @p aOffset and @p aNameBuffer are updated. * @retval kErrorParse The CNAME record in @p aMessage could not be parsed (invalid format). @@ -1610,14 +1610,14 @@ public: * This method also verifies that the PTR record is well-formed (e.g., the record data length `GetLength()` matches * the PTR encoded name). * - * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of + * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of * DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage to start of PTR name field. + * @param[in,out] aOffset On input, the offset in @p aMessage to start of PTR name field. * On exit when successfully read, @p aOffset is updated to point to the byte * after the entire PTR record (skipping over the record). - * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string + * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string * (MUST NOT be `nullptr`). - * @param[in] aNameBufferSize The size of @p aNameBuffer. + * @param[in] aNameBufferSize The size of @p aNameBuffer. * * @retval kErrorNone The PTR name was read successfully. @p aOffset and @p aNameBuffer are updated. * @retval kErrorParse The PTR record in @p aMessage could not be parsed (invalid format). @@ -1643,17 +1643,17 @@ public: * intended for "Service Instance Name" where first label (`` portion) can be a user-friendly string and * can contain dot character. * - * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of - * DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage to the start of PTR name field. - * On exit, when successfully read, @p aOffset is updated to point to the byte - * after the entire PTR record (skipping over the record). - * @param[out] aLabelBuffer A pointer to a char array to output the first label as a null-terminated C - * string (MUST NOT be `nullptr`). - * @param[in] aLabelBufferSize The size of @p aLabelBuffer. - * @param[out] aNameBuffer A pointer to a char array to output the rest of name (after first label). Can - * be `nullptr` if caller is only interested in the first label. - * @param[in] aNameBufferSize The size of @p aNameBuffer. + * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of + * DNS header. + * @param[in,out] aOffset On input, the offset in @p aMessage to the start of PTR name field. + * On exit, when successfully read, @p aOffset is updated to point to the byte + * after the entire PTR record (skipping over the record). + * @param[out] aLabelBuffer A pointer to a char array to output the first label as a null-terminated C + * string (MUST NOT be `nullptr`). + * @param[in] aLabelBufferSize The size of @p aLabelBuffer. + * @param[out] aNameBuffer A pointer to a char array to output the rest of name (after first label). Can + * be `nullptr` if caller is only interested in the first label. + * @param[in] aNameBufferSize The size of @p aNameBuffer. * * @retval kErrorNone The PTR name was read successfully. @p aOffset, @aLabelBuffer and @aNameBuffer are updated. * @retval kErrorParse The PTR record in @p aMessage could not be parsed (invalid format). @@ -1694,12 +1694,12 @@ public: * * This method also checks if the TXT data is well-formed by calling `VerifyTxtData()`. * - * @param[in] aMessage The message to read from. - * @param[inout] aOffset On input, the offset in @p aMessage to start of TXT record data. + * @param[in] aMessage The message to read from. + * @param[in,out] aOffset On input, the offset in @p aMessage to start of TXT record data. * On exit when successfully read, @p aOffset is updated to point to the byte * after the entire TXT record (skipping over the record). - * @param[out] aTxtBuffer A pointer to a byte array to output the read TXT data. - * @param[inout] aTxtBufferSize On input, the size of @p aTxtBuffer (max bytes that can be read). + * @param[out] aTxtBuffer A pointer to a byte array to output the read TXT data. + * @param[in,out] aTxtBufferSize On input, the size of @p aTxtBuffer (max bytes that can be read). * On exit, @p aTxtBufferSize gives number of bytes written to @p aTxtBuffer. * * @retval kErrorNone The TXT data was read successfully. @p aOffset, @p aTxtBuffer and @p aTxtBufferSize @@ -1848,14 +1848,14 @@ public: * This method also verifies that the SRV record is well-formed (e.g., the record data length `GetLength()` matches * the SRV encoded name). * - * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of + * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of * DNS header. - * @param[inout] aOffset On input, the offset in @p aMessage to start of target host name field. + * @param[in,out] aOffset On input, the offset in @p aMessage to start of target host name field. * On exit when successfully read, @p aOffset is updated to point to the byte * after the entire SRV record (skipping over the record). - * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string + * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string * (MUST NOT be `nullptr`). - * @param[in] aNameBufferSize The size of @p aNameBuffer. + * @param[in] aNameBufferSize The size of @p aNameBuffer. * * @retval kErrorNone The host name was read successfully. @p aOffset and @p aNameBuffer are updated. * @retval kErrorParse The SRV record in @p aMessage could not be parsed (invalid format). @@ -2251,14 +2251,14 @@ public: /** * This method parses and reads the SIG signer name from a message. * - * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of DNS + * @param[in] aMessage The message to read from. `aMessage.GetOffset()` MUST point to the start of DNS * header. - * @param[inout] aOffset On input, the offset in @p aMessage to start of signer name field. + * @param[in,out] aOffset On input, the offset in @p aMessage to start of signer name field. * On exit when successfully read, @p aOffset is updated to point to the byte * after the name field (i.e., start of signature field). - * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string + * @param[out] aNameBuffer A pointer to a char array to output the read name as a null-terminated C string * (MUST NOT be `nullptr`). - * @param[in] aNameBufferSize The size of @p aNameBuffer. + * @param[in] aNameBufferSize The size of @p aNameBuffer. * * @retval kErrorNone The name was read successfully. @p aOffset and @p aNameBuffer are updated. * @retval kErrorParse The SIG record in @p aMessage could not be parsed (invalid format). diff --git a/src/core/thread/address_resolver.hpp b/src/core/thread/address_resolver.hpp index 5ce68e67e..6a177b9a8 100644 --- a/src/core/thread/address_resolver.hpp +++ b/src/core/thread/address_resolver.hpp @@ -96,8 +96,8 @@ public: /** * This method gets the information about the next EID cache entry (using an iterator). * - * @param[out] aInfo An `EntryInfo` where the EID cache entry information is placed. - * @param[inout] aIterator An iterator. It will be updated to point to the next entry on success. + * @param[out] aInfo An `EntryInfo` where the EID cache entry information is placed. + * @param[in,out] aIterator An iterator. It will be updated to point to the next entry on success. * To get the first entry, initialize the iterator by setting all its fields to zero. * e.g., `memset` the the iterator structure to zero. * diff --git a/src/core/thread/neighbor_table.hpp b/src/core/thread/neighbor_table.hpp index 80433ccf0..abe2df67f 100644 --- a/src/core/thread/neighbor_table.hpp +++ b/src/core/thread/neighbor_table.hpp @@ -194,9 +194,9 @@ public: * This method gets the next neighbor information. It is used to iterate through the entries of * the neighbor table. * - * @param[inout] aIterator A reference to the iterator context. To get the first neighbor entry - it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT. - * @param[out] aNeighInfo The neighbor information. + * @param[in,out] aIterator A reference to the iterator context. To get the first neighbor entry + it should be set to OT_NEIGHBOR_INFO_ITERATOR_INIT. + * @param[out] aNeighInfo The neighbor information. * * @retval kErrorNone Successfully found the next neighbor entry in table. * @retval kErrorNotFound No subsequent neighbor entry exists in the table. diff --git a/src/core/thread/network_data.hpp b/src/core/thread/network_data.hpp index 37e78bef1..3dc80d892 100644 --- a/src/core/thread/network_data.hpp +++ b/src/core/thread/network_data.hpp @@ -168,10 +168,10 @@ public: /** * This method provides full or stable copy of the Thread Network Data. * - * @param[in] aType The Network Data type to copy, the full set or stable subset. - * @param[out] aData A pointer to the data buffer to copy the Network Data into. - * @param[inout] aDataLength On entry, size of the data buffer pointed to by @p aData. - * On exit, number of copied bytes. + * @param[in] aType The Network Data type to copy, the full set or stable subset. + * @param[out] aData A pointer to the data buffer to copy the Network Data into. + * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. + * On exit, number of copied bytes. * * @retval kErrorNone Successfully copied Thread Network Data. * @retval kErrorNoBufs Not enough space in @p aData to fully copy Thread Network Data. @@ -194,8 +194,8 @@ public: /** * This method provides the next On Mesh prefix in the Thread Network Data. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[out] aConfig A reference to a config variable where the On Mesh Prefix information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[out] aConfig A reference to a config variable where the On Mesh Prefix information will be placed. * * @retval kErrorNone Successfully found the next On Mesh prefix. * @retval kErrorNotFound No subsequent On Mesh prefix exists in the Thread Network Data. @@ -206,9 +206,9 @@ public: /** * This method provides the next On Mesh prefix in the Thread Network Data for a given RLOC16. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[in] aRloc16 The RLOC16 value. - * @param[out] aConfig A reference to a config variable where the On Mesh Prefix information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[in] aRloc16 The RLOC16 value. + * @param[out] aConfig A reference to a config variable where the On Mesh Prefix information will be placed. * * @retval kErrorNone Successfully found the next On Mesh prefix. * @retval kErrorNotFound No subsequent On Mesh prefix exists in the Thread Network Data. @@ -219,8 +219,8 @@ public: /** * This method provides the next external route in the Thread Network Data. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[out] aConfig A reference to a config variable where the external route information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[out] aConfig A reference to a config variable where the external route information will be placed. * * @retval kErrorNone Successfully found the next external route. * @retval kErrorNotFound No subsequent external route exists in the Thread Network Data. @@ -231,9 +231,9 @@ public: /** * This method provides the next external route in the Thread Network Data for a given RLOC16. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[in] aRloc16 The RLOC16 value. - * @param[out] aConfig A reference to a config variable where the external route information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[in] aRloc16 The RLOC16 value. + * @param[out] aConfig A reference to a config variable where the external route information will be placed. * * @retval kErrorNone Successfully found the next external route. * @retval kErrorNotFound No subsequent external route exists in the Thread Network Data. @@ -244,8 +244,8 @@ public: /** * This method provides the next service in the Thread Network Data. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[out] aConfig A reference to a config variable where the service information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[out] aConfig A reference to a config variable where the service information will be placed. * * @retval kErrorNone Successfully found the next service. * @retval kErrorNotFound No subsequent service exists in the Thread Network Data. @@ -256,9 +256,9 @@ public: /** * This method provides the next service in the Thread Network Data for a given RLOC16. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[in] aRloc16 The RLOC16 value. - * @param[out] aConfig A reference to a config variable where the service information will be placed. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[in] aRloc16 The RLOC16 value. + * @param[out] aConfig A reference to a config variable where the service information will be placed. * * @retval kErrorNone Successfully found the next service. * @retval kErrorNotFound No subsequent service exists in the Thread Network Data. @@ -315,8 +315,8 @@ public: /** * This method provides the next server RLOC16 in the Thread Network Data. * - * @param[inout] aIterator A reference to the Network Data iterator. - * @param[out] aRloc16 The RLOC16 value. + * @param[in,out] aIterator A reference to the Network Data iterator. + * @param[out] aRloc16 The RLOC16 value. * * @retval kErrorNone Successfully found the next server. * @retval kErrorNotFound No subsequent server exists in the Thread Network Data. diff --git a/src/core/thread/network_data_service.hpp b/src/core/thread/network_data_service.hpp index 8c0c0606e..b7f16f97c 100644 --- a/src/core/thread/network_data_service.hpp +++ b/src/core/thread/network_data_service.hpp @@ -560,8 +560,8 @@ public: * To get the first entry, @p aIterator should be cleared (e.g., a new instance of `Iterator` or calling `Clear()` * method). * - * @param[inout] aIterator A reference to an iterator. - * @param[out] aInfo A reference to `DnsSrpAnycast::Info` to return the info. + * @param[in,out] aIterator A reference to an iterator. + * @param[out] aInfo A reference to `DnsSrpAnycast::Info` to return the info. * * @retval kErrorNone Successfully got the next info. @p aInfo and @p aIterator are updated. * @retval kErrorNotFound No more matching entries in the Network Data. @@ -590,8 +590,8 @@ public: * To get the first entry @p aIterator should be cleared (e.g., a new instance of `Iterator` or calling `Clear()` * method). * - * @param[inout] aIterator A reference to an iterator. - * @param[out] aInfo A reference to `DnsSrpUnicast::Info` to return the info. + * @param[in,out] aIterator A reference to an iterator. + * @param[out] aInfo A reference to `DnsSrpUnicast::Info` to return the info. * * @retval kErrorNone Successfully got the next info. @p aInfo and @p aIterator are updated. * @retval kErrorNotFound No more matching entries in the Network Data. diff --git a/src/core/thread/network_diagnostic.hpp b/src/core/thread/network_diagnostic.hpp index a475a0912..ade893fd9 100644 --- a/src/core/thread/network_diagnostic.hpp +++ b/src/core/thread/network_diagnostic.hpp @@ -111,9 +111,10 @@ public: /** * This static method gets the next Network Diagnostic TLV in a given message. * - * @param[in] aMessage A message. - * @param[inout] aIterator The Network Diagnostic iterator. To get the first TLV set it to `kIteratorInit`. - * @param[out] aNetworkDiagTlv A reference to a Network Diagnostic TLV to output the next TLV. + * @param[in] aMessage A message. + * @param[in,out] aIterator The Network Diagnostic iterator. To get the first TLV set it to + * `kIteratorInit`. + * @param[out] aNetworkDiagTlv A reference to a Network Diagnostic TLV to output the next TLV. * * @retval kErrorNone Successfully found the next Network Diagnostic TLV. * @retval kErrorNotFound No subsequent Network Diagnostic TLV exists in the message. diff --git a/src/core/thread/radio_selector.hpp b/src/core/thread/radio_selector.hpp index 75da6a8e7..bf980cc15 100644 --- a/src/core/thread/radio_selector.hpp +++ b/src/core/thread/radio_selector.hpp @@ -173,9 +173,9 @@ public: * The `aMessage` will be updated to store the selected radio type (please see `Message::GetRadioType()`). * The `aTxFrames` will also be updated to indicate which radio links are to be used. * - * @param[inout] aMessage The message to send. - * @param[in] aMacDest The MAC destination address. - * @param[inout] aTxFrames The set of TxFrames for all radio links. + * @param[in,out] aMessage The message to send. + * @param[in] aMacDest The MAC destination address. + * @param[in,out] aTxFrames The set of TxFrames for all radio links. * * @returns A reference to `mTxFrame` to use when preparing the frame for tx. * diff --git a/src/core/thread/time_sync_service.hpp b/src/core/thread/time_sync_service.hpp index d1c551190..4f2e14449 100644 --- a/src/core/thread/time_sync_service.hpp +++ b/src/core/thread/time_sync_service.hpp @@ -66,7 +66,7 @@ public: /** * Get the Thread network time. * - * @param[inout] aNetworkTime The Thread network time in microseconds. + * @param[in,out] aNetworkTime The Thread network time in microseconds. * * @returns The time synchronization status. * diff --git a/src/core/utils/flash.hpp b/src/core/utils/flash.hpp index 84c83b5ad..795a47a59 100644 --- a/src/core/utils/flash.hpp +++ b/src/core/utils/flash.hpp @@ -69,15 +69,15 @@ public: /** * This method fetches the value identified by @p aKey. * - * @param[in] aKey The key associated with the requested value. - * @param[in] aIndex The index of the specific item to get. - * @param[out] aValue A pointer to where the value of the setting should be written. - * May be `nullptr` if just testing for the presence or length of a key. - * @param[inout] aValueLength A pointer to the length of the value. - * When called, this should point to an integer containing the maximum bytes that - * can be written to @p aValue. - * At return, the actual length of the setting is written. - * May be `nullptr` if performing a presence check. + * @param[in] aKey The key associated with the requested value. + * @param[in] aIndex The index of the specific item to get. + * @param[out] aValue A pointer to where the value of the setting should be written. + * May be `nullptr` if just testing for the presence or length of a key. + * @param[in,out] aValueLength A pointer to the length of the value. + * When called, this should point to an integer containing the maximum bytes that + * can be written to @p aValue. + * At return, the actual length of the setting is written. + * May be `nullptr` if performing a presence check. * * @retval kErrorNone The value was fetched successfully. * @retval kErrorNotFound The key was not found. diff --git a/src/core/utils/history_tracker.hpp b/src/core/utils/history_tracker.hpp index a3670983f..3a0a2ee2d 100644 --- a/src/core/utils/history_tracker.hpp +++ b/src/core/utils/history_tracker.hpp @@ -139,10 +139,11 @@ public: /** * This method iterates over the entries in the network info history list. * - * @param[inout] aIterator An iterator. MUST be initialized. - * @param[out] aEntryAge A reference to a variable to output the entry's age. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max age. + * @param[in,out] aIterator An iterator. MUST be initialized. + * @param[out] aEntryAge A reference to a variable to output the entry's age. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max + * age. * * @returns A pointer to `NetworkInfo` entry or `nullptr` if no more entries in the list. * @@ -155,10 +156,11 @@ public: /** * This method iterates over the entries in the unicast address history list. * - * @param[inout] aIterator An iterator. MUST be initialized. - * @param[out] aEntryAge A reference to a variable to output the entry's age. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max age. + * @param[in,out] aIterator An iterator. MUST be initialized. + * @param[out] aEntryAge A reference to a variable to output the entry's age. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max + * age. * * @returns A pointer to `UnicastAddress` entry or `nullptr` if no more entries in the list. * @@ -171,10 +173,11 @@ public: /** * This method iterates over the entries in the multicast address history list. * - * @param[inout] aIterator An iterator. MUST be initialized. - * @param[out] aEntryAge A reference to a variable to output the entry's age. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max age. + * @param[in,out] aIterator An iterator. MUST be initialized. + * @param[out] aEntryAge A reference to a variable to output the entry's age. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max + * age. * * @returns A pointer to `MulticastAddress` entry or `nullptr` if no more entries in the list. * @@ -187,10 +190,11 @@ public: /** * This method iterates over the entries in the RX history list. * - * @param[inout] aIterator An iterator. MUST be initialized. - * @param[out] aEntryAge A reference to a variable to output the entry's age. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max age. + * @param[in,out] aIterator An iterator. MUST be initialized. + * @param[out] aEntryAge A reference to a variable to output the entry's age. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max + * age. * * @returns A pointer to `MessageInfo` entry or `nullptr` if no more entries in the list. * @@ -203,10 +207,11 @@ public: /** * This method iterates over the entries in the TX history list. * - * @param[inout] aIterator An iterator. MUST be initialized. - * @param[out] aEntryAge A reference to a variable to output the entry's age. - * Age is provided as the duration (in milliseconds) from when entry was recorded to - * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max age. + * @param[in,out] aIterator An iterator. MUST be initialized. + * @param[out] aEntryAge A reference to a variable to output the entry's age. + * Age is provided as the duration (in milliseconds) from when entry was recorded to + * @p aIterator initialization time. It is set to `kMaxAge` for entries older than max + * age. * * @returns A pointer to `MessageInfo` entry or `nullptr` if no more entries in the list. * diff --git a/src/core/utils/parse_cmdline.hpp b/src/core/utils/parse_cmdline.hpp index 88b0cc8c4..6b9025f6f 100644 --- a/src/core/utils/parse_cmdline.hpp +++ b/src/core/utils/parse_cmdline.hpp @@ -249,10 +249,10 @@ template static otError ParseAsHexString(const char *aStr * This function correctly handles hex strings with even or odd length. For example, "AABBCCDD" (with even length) is * parsed as {0xaa, 0xbb, 0xcc, 0xdd} and "123" (with odd length) is parsed as {0x01, 0x23}. * - * @param[in] aString The string to parse. - * @param[inout] aSize On entry indicates the number of bytes in @p aBuffer (max size of @p aBuffer). - * On exit provides number of bytes parsed and copied into @p aBuffer. - * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. + * @param[in] aString The string to parse. + * @param[in,out] aSize On entry indicates the number of bytes in @p aBuffer (max size of @p aBuffer). + * On exit provides number of bytes parsed and copied into @p aBuffer. + * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. * * @retval kErrorNone The string was parsed successfully. * @retval kErrorInvalidArgs The string does not contain valid format or too many bytes. @@ -271,10 +271,10 @@ otError ParseAsHexString(const char *aString, uint16_t &aSize, uint8_t *aBuffer) * This function correctly handles hex strings with even or odd length. For example, "AABBCCDD" (with even length) is * parsed as {0xaa, 0xbb, 0xcc, 0xdd} and "123" (with odd length) is parsed as {0x01, 0x23}. * - * @param[inout] aString A reference to string to parse. On successful parse, updated to skip parsed digits. - * @param[inout] aSize On entry indicates the segment size (number of bytes in @p aBuffer). + * @param[in,out] aString A reference to string to parse. On successful parse, updated to skip parsed digits. + * @param[in,out] aSize On entry indicates the segment size (number of bytes in @p aBuffer). * On exit provides number of bytes parsed and copied into @p aBuffer. - * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. + * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. * * @retval kErrorNone The string was parsed successfully to the end of string. * @retval kErrorPedning The string segment was parsed successfully, but there are additional bytes remaining @@ -557,9 +557,9 @@ public: * * This method verifies that the parsed hex string bytes fit in @p aBuffer with its given @p aSize. * - * @param[inout] aSize On entry indicates the number of bytes in @p aBuffer (max size of @p aBuffer). + * @param[in,out] aSize On entry indicates the number of bytes in @p aBuffer (max size of @p aBuffer). * On exit provides number of bytes parsed and copied into @p aBuffer. - * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. + * @param[out] aBuffer A pointer to a buffer to output the parsed byte sequence. * * @retval kErrorNone The argument was parsed successfully. * @retval kErrorInvalidArgs The argument does not contain valid format or too many bytes. diff --git a/src/core/utils/slaac_address.hpp b/src/core/utils/slaac_address.hpp index 23f3e6164..db7913b36 100644 --- a/src/core/utils/slaac_address.hpp +++ b/src/core/utils/slaac_address.hpp @@ -126,12 +126,12 @@ public: /** * This method generates the IID of an IPv6 address. * - * @param[inout] aAddress A reference to the address that will be filled with the IID generated. + * @param[in,out] aAddress A reference to the address that will be filled with the IID generated. * Note the prefix of the address must already be filled and will be used * to generate the IID. - * @param[in] aNetworkId A pointer to a byte array of Network_ID to generate IID. - * @param[in] aNetworkIdLength The size of array @p aNetworkId. - * @param[inout] aDadCounter A pointer to the DAD_Counter that is employed to resolve Duplicate + * @param[in] aNetworkId A pointer to a byte array of Network_ID to generate IID. + * @param[in] aNetworkIdLength The size of array @p aNetworkId. + * @param[in,out] aDadCounter A pointer to the DAD_Counter that is employed to resolve Duplicate * Address Detection connflicts. * * @retval kErrorNone If successfully generated the IID. diff --git a/src/lib/hdlc/hdlc.hpp b/src/lib/hdlc/hdlc.hpp index 26468aaa2..84581d1ee 100644 --- a/src/lib/hdlc/hdlc.hpp +++ b/src/lib/hdlc/hdlc.hpp @@ -353,11 +353,11 @@ public: /** * This method iterates through previously saved frames in the buffer, getting a next frame in the queue. * - * @param[inout] aFrame On entry, should point to a previous saved frame or nullptr to get the first frame. - * On exit, the pointer variable is updated to next frame or set to nullptr if there are - * none. - * @param[inout] aLength On entry, should be a reference to the frame length of the previous saved frame. - * On exit, the reference is updated to the frame length (number of bytes) of next frame. + * @param[in,out] aFrame On entry, should point to a previous saved frame or nullptr to get the first frame. + * On exit, the pointer variable is updated to next frame or set to nullptr if there are + * none. + * @param[in,out] aLength On entry, should be a reference to the frame length of the previous saved frame. + * On exit, the reference is updated to the frame length (number of bytes) of next frame. * * @retval OT_ERROR_NONE Updated @aFrame and @aLength successfully with the next saved frame. * @retval OT_ERROR_NOT_FOUND No more saved frame in the buffer. diff --git a/src/posix/main.c b/src/posix/main.c index 74b85f2f3..0096409a7 100644 --- a/src/posix/main.c +++ b/src/posix/main.c @@ -89,7 +89,7 @@ void otAppNcpUpdate(otSysMainloopContext *aContext); /** * This function updates the file descriptor sets with file descriptors used by console. * - * @param[inout] aMainloop A pointer to the mainloop context. + * @param[in,out] aMainloop A pointer to the mainloop context. * */ void otAppNcpProcess(const otSysMainloopContext *aContext); @@ -111,7 +111,7 @@ void otAppCliDeinit(void); /** * This function updates the file descriptor sets with file descriptors used by console. * - * @param[inout] aMainloop A pointer to the mainloop context. + * @param[in,out] aMainloop A pointer to the mainloop context. * */ void otAppCliUpdate(otSysMainloopContext *aMainloop); diff --git a/src/posix/platform/hdlc_interface.hpp b/src/posix/platform/hdlc_interface.hpp index 73c1a3936..32ada0346 100644 --- a/src/posix/platform/hdlc_interface.hpp +++ b/src/posix/platform/hdlc_interface.hpp @@ -120,10 +120,10 @@ public: /** * This method updates the file descriptor sets with file descriptors used by the radio driver. * - * @param[inout] aReadFdSet A reference to the read file descriptors. - * @param[inout] aWriteFdSet A reference to the write file descriptors. - * @param[inout] aMaxFd A reference to the max file descriptor. - * @param[inout] aTimeout A reference to the timeout. + * @param[in,out] aReadFdSet A reference to the read file descriptors. + * @param[in,out] aWriteFdSet A reference to the write file descriptors. + * @param[in,out] aMaxFd A reference to the max file descriptor. + * @param[in,out] aTimeout A reference to the timeout. * */ void UpdateFdSet(fd_set &aReadFdSet, fd_set &aWriteFdSet, int &aMaxFd, struct timeval &aTimeout); diff --git a/src/posix/platform/include/openthread/openthread-system.h b/src/posix/platform/include/openthread/openthread-system.h index dfc4f1f20..e8210703b 100644 --- a/src/posix/platform/include/openthread/openthread-system.h +++ b/src/posix/platform/include/openthread/openthread-system.h @@ -123,7 +123,7 @@ typedef struct otSysMainloopContext * This function updates the file descriptor sets with file descriptors used by OpenThread drivers. * * @param[in] aInstance The OpenThread instance structure. - * @param[inout] aMainloop A pointer to the mainloop context. + * @param[in,out] aMainloop A pointer to the mainloop context. * */ void otSysMainloopUpdate(otInstance *aInstance, otSysMainloopContext *aMainloop); @@ -131,7 +131,7 @@ void otSysMainloopUpdate(otInstance *aInstance, otSysMainloopContext *aMainloop) /** * This function polls OpenThread's mainloop. * - * @param[inout] aMainloop A pointer to the mainloop context. + * @param[in,out] aMainloop A pointer to the mainloop context. * * @returns value returned from select(). * diff --git a/src/posix/platform/include/openthread/platform/secure_settings.h b/src/posix/platform/include/openthread/platform/secure_settings.h index 90ce5c312..d206c269a 100644 --- a/src/posix/platform/include/openthread/platform/secure_settings.h +++ b/src/posix/platform/include/openthread/platform/secure_settings.h @@ -79,15 +79,15 @@ void otPosixSecureSettingsDeinit(otInstance *aInstance); * Note that the underlying storage implementation is not required to maintain the order of settings with multiple * values. The order of such values MAY change after ANY write operation to the store. * - * @param[in] aInstance The OpenThread instance structure. - * @param[in] aKey The key associated with the requested setting. - * @param[in] aIndex The index of the specific item to get. - * @param[out] aValue A pointer to where the value of the setting should be written. May be set to NULL if - * just testing for the presence or length of a setting. - * @param[inout] aValueLength A pointer to the length of the value. When called, this pointer should point to an - * integer containing the maximum value size that can be written to aValue. At return, - * the actual length of the setting is written. This may be set to NULL if performing - * a presence check. + * @param[in] aInstance The OpenThread instance structure. + * @param[in] aKey The key associated with the requested setting. + * @param[in] aIndex The index of the specific item to get. + * @param[out] aValue A pointer to where the value of the setting should be written. May be set to NULL if + * just testing for the presence or length of a setting. + * @param[in,out] aValueLength A pointer to the length of the value. When called, this pointer should point to an + * integer containing the maximum value size that can be written to aValue. At return, + * the actual length of the setting is written. This may be set to NULL if performing + * a presence check. * * @retval OT_ERROR_NONE The given setting was found and fetched successfully. * @retval OT_ERROR_NOT_FOUND The given setting was not found in the setting store. diff --git a/src/posix/platform/infra_if.hpp b/src/posix/platform/infra_if.hpp index 11d777f13..ccd2b1206 100644 --- a/src/posix/platform/infra_if.hpp +++ b/src/posix/platform/infra_if.hpp @@ -53,7 +53,7 @@ public: /** * This method updates the fd_set and timeout for mainloop. * - * @param[inout] aContext A reference to the mainloop context. + * @param[in,out] aContext A reference to the mainloop context. * */ void Update(otSysMainloopContext &aContext) override; diff --git a/src/posix/platform/mainloop.hpp b/src/posix/platform/mainloop.hpp index e6e7e25f5..d4f6ac8ff 100644 --- a/src/posix/platform/mainloop.hpp +++ b/src/posix/platform/mainloop.hpp @@ -52,7 +52,7 @@ public: /** * This method registers events in the mainloop. * - * @param[inout] aContext A reference to the mainloop context. + * @param[in,out] aContext A reference to the mainloop context. * */ virtual void Update(otSysMainloopContext &aContext) = 0; @@ -79,7 +79,7 @@ public: /** * This method updates event polls in the mainloop context. * - * @param[inout] aContext A reference to the mainloop context. + * @param[in,out] aContext A reference to the mainloop context. * */ void Update(otSysMainloopContext &aContext); diff --git a/src/posix/platform/platform-posix.h b/src/posix/platform/platform-posix.h index 0f9793b7a..919a319e2 100644 --- a/src/posix/platform/platform-posix.h +++ b/src/posix/platform/platform-posix.h @@ -183,10 +183,10 @@ void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLen /** * This function updates the file descriptor sets with file descriptors used by the radio driver. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. - * @param[inout] aTimeout A pointer to the timeout. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aTimeout A pointer to the timeout. * */ void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aMaxFd, struct timeval *aTimeout); @@ -218,9 +218,9 @@ void platformLoggingInit(const char *aName); /** * This function updates the file descriptor sets with file descriptors used by the UART driver. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. * */ void platformUartUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd); @@ -274,10 +274,10 @@ void platformNetifDeinit(void); /** * This function updates the file descriptor sets with file descriptors used by platform netif module. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aErrorFdSet A pointer to the error file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aErrorFdSet A pointer to the error file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. * */ void platformNetifUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd); @@ -332,11 +332,11 @@ void virtualTimeProcess(otInstance * aInstance, * This function updates the file descriptor sets with file descriptors * used by the virtual time simulation. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aErrorFdSet A pointer to the error file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. - * @param[inout] aTimeout A pointer to the timeout. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aErrorFdSet A pointer to the error file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aTimeout A pointer to the timeout. * */ void virtualTimeUpdateFdSet(fd_set * aReadFdSet, @@ -402,10 +402,10 @@ void platformTrelDeinit(void); /** * This function updates the file descriptor sets with file descriptors used by the TREL driver. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aMaxFd A pointer to the max file descriptor. - * @param[inout] aTimeout A pointer to the timeout. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aMaxFd A pointer to the max file descriptor. + * @param[in,out] aTimeout A pointer to the timeout. * */ void platformTrelUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, int *aMaxFd, struct timeval *aTimeout); diff --git a/src/posix/platform/spi_interface.hpp b/src/posix/platform/spi_interface.hpp index f9e080710..13bf00f86 100644 --- a/src/posix/platform/spi_interface.hpp +++ b/src/posix/platform/spi_interface.hpp @@ -122,10 +122,10 @@ public: /** * This method updates the file descriptor sets with file descriptors used by the radio driver. * - * @param[inout] aReadFdSet A reference to the read file descriptors. - * @param[inout] aWriteFdSet A reference to the write file descriptors. - * @param[inout] aMaxFd A reference to the max file descriptor. - * @param[inout] aTimeout A reference to the timeout. + * @param[in,out] aReadFdSet A reference to the read file descriptors. + * @param[in,out] aWriteFdSet A reference to the write file descriptors. + * @param[in,out] aMaxFd A reference to the max file descriptor. + * @param[in,out] aTimeout A reference to the timeout. * */ void UpdateFdSet(fd_set &aReadFdSet, fd_set &aWriteFdSet, int &aMaxFd, struct timeval &aTimeout); diff --git a/src/posix/platform/system.cpp b/src/posix/platform/system.cpp index d3d4c2237..eff0d7d4d 100644 --- a/src/posix/platform/system.cpp +++ b/src/posix/platform/system.cpp @@ -263,9 +263,9 @@ void otSysDeinit(void) /** * This function try selecting the given file descriptors in nonblocking mode. * - * @param[inout] aReadFdSet A pointer to the read file descriptors. - * @param[inout] aWriteFdSet A pointer to the write file descriptors. - * @param[inout] aErrorFdSet A pointer to the error file descriptors. + * @param[in,out] aReadFdSet A pointer to the read file descriptors. + * @param[in,out] aWriteFdSet A pointer to the write file descriptors. + * @param[in,out] aErrorFdSet A pointer to the error file descriptors. * @param[in] aMaxFd The max file descriptor. * * @returns The value returned from select().