espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-31 14:29:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doxygen] change inout to in,out (#7461)

Browse Source
This commit is contained in:
Jonathan Hui
2022-03-10 14:34:20 -08:00
committed by GitHub
parent c16abe00e6
commit 0a74d66fed
54 changed files with 484 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/platforms/simulation/platform-simulation.h
+10 -10
View File
@@ -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);
examples/platforms/utils/logging_rtt.c
+5 -5
View File
@@ -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.
*/
examples/platforms/utils/mac_frame.h
+3 -3
View File
@@ -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.
*
*/