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

[cli] update documentation of Process() method in CLI sub-modules (#9093)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2023-05-26 15:41:09 -07:00
committed by GitHub
parent 323ffd894b
commit 77d4b78a69
14 changed files with 109 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/cli_br.hpp
+8 -2
View File
@@ -66,9 +66,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_coap.hpp
+8 -2
View File
@@ -64,9 +64,15 @@ public:
Coap(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_coap_secure.hpp
+8 -2
View File
@@ -70,9 +70,15 @@ public:
CoapSecure(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_commissioner.hpp
+8 -2
View File
@@ -67,9 +67,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_dataset.hpp
+8 -2
View File
@@ -60,9 +60,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_dns.hpp
+8 -2
View File
@@ -81,9 +81,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_history.hpp
+8 -2
View File
@@ -68,9 +68,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_joiner.hpp
+8 -2
View File
@@ -67,9 +67,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer to an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_mac_filter.hpp
+6 -5
View File
@@ -68,14 +68,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @reval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retavl OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error handling the command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_network_data.hpp
+8 -2
View File
@@ -77,9 +77,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_srp_client.hpp
+8 -2
View File
@@ -66,9 +66,15 @@ public:
SrpClient(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_srp_server.hpp
+7 -4
View File
@@ -67,12 +67,15 @@ public:
}
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs A pointer to an array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval ... Failed to execute the CLI command.
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_tcp.hpp
+8 -2
View File
@@ -74,9 +74,15 @@ public:
TcpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);
src/cli/cli_udp.hpp
+8 -2
View File
@@ -62,9 +62,15 @@ public:
UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method interprets a list of CLI arguments.
* This method processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
* @param[in] aArgs An array of command line arguments.
*
* @retval OT_ERROR_NONE Successfully executed the CLI command.
* @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending.
* @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments.
* @retval ... Error during execution of the CLI command.
*
*/
otError Process(Arg aArgs[]);