diff --git a/src/cli/cli_br.hpp b/src/cli/cli_br.hpp index 794f8741f..cd013096f 100644 --- a/src/cli/cli_br.hpp +++ b/src/cli/cli_br.hpp @@ -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[]); diff --git a/src/cli/cli_coap.hpp b/src/cli/cli_coap.hpp index 041e7ae94..feb977128 100644 --- a/src/cli/cli_coap.hpp +++ b/src/cli/cli_coap.hpp @@ -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[]); diff --git a/src/cli/cli_coap_secure.hpp b/src/cli/cli_coap_secure.hpp index 9bdc63135..3b95cd723 100644 --- a/src/cli/cli_coap_secure.hpp +++ b/src/cli/cli_coap_secure.hpp @@ -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[]); diff --git a/src/cli/cli_commissioner.hpp b/src/cli/cli_commissioner.hpp index 7b63cb0d2..d2c2705da 100644 --- a/src/cli/cli_commissioner.hpp +++ b/src/cli/cli_commissioner.hpp @@ -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[]); diff --git a/src/cli/cli_dataset.hpp b/src/cli/cli_dataset.hpp index 7f11ec302..1ec231450 100644 --- a/src/cli/cli_dataset.hpp +++ b/src/cli/cli_dataset.hpp @@ -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[]); diff --git a/src/cli/cli_dns.hpp b/src/cli/cli_dns.hpp index b9eb8d892..f746b4d79 100644 --- a/src/cli/cli_dns.hpp +++ b/src/cli/cli_dns.hpp @@ -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[]); diff --git a/src/cli/cli_history.hpp b/src/cli/cli_history.hpp index cab6d79eb..42ff6e3e2 100644 --- a/src/cli/cli_history.hpp +++ b/src/cli/cli_history.hpp @@ -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[]); diff --git a/src/cli/cli_joiner.hpp b/src/cli/cli_joiner.hpp index cc3ddac2c..677c5eb76 100644 --- a/src/cli/cli_joiner.hpp +++ b/src/cli/cli_joiner.hpp @@ -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[]); diff --git a/src/cli/cli_mac_filter.hpp b/src/cli/cli_mac_filter.hpp index da2c8980e..ac481b503 100644 --- a/src/cli/cli_mac_filter.hpp +++ b/src/cli/cli_mac_filter.hpp @@ -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[]); diff --git a/src/cli/cli_network_data.hpp b/src/cli/cli_network_data.hpp index d751c4587..9b9f42626 100644 --- a/src/cli/cli_network_data.hpp +++ b/src/cli/cli_network_data.hpp @@ -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[]); diff --git a/src/cli/cli_srp_client.hpp b/src/cli/cli_srp_client.hpp index 9b9ea4237..9316c4278 100644 --- a/src/cli/cli_srp_client.hpp +++ b/src/cli/cli_srp_client.hpp @@ -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[]); diff --git a/src/cli/cli_srp_server.hpp b/src/cli/cli_srp_server.hpp index 6d179d2a9..831327c3b 100644 --- a/src/cli/cli_srp_server.hpp +++ b/src/cli/cli_srp_server.hpp @@ -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[]); diff --git a/src/cli/cli_tcp.hpp b/src/cli/cli_tcp.hpp index 9af459dbe..a10570a66 100644 --- a/src/cli/cli_tcp.hpp +++ b/src/cli/cli_tcp.hpp @@ -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[]); diff --git a/src/cli/cli_udp.hpp b/src/cli/cli_udp.hpp index 55996c7ec..14003e14b 100644 --- a/src/cli/cli_udp.hpp +++ b/src/cli/cli_udp.hpp @@ -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[]);