From 12af0231215d34b751c8dc318fa11d77dbfefb9e Mon Sep 17 00:00:00 2001 From: jrhodie <139580534+jrhodie@users.noreply.github.com> Date: Mon, 11 Dec 2023 15:28:40 -0800 Subject: [PATCH] [cli] add aliases for TCP and SRP concepts guides (#9707) * Adding aliases for TCP and SRP concepts guides * TCP and SRP concept guides now referenced by Command Ref CLIs --- src/cli/cli_srp_client.cpp | 11 +++++++++++ src/cli/cli_srp_server.cpp | 5 +++++ src/cli/cli_tcp.cpp | 4 ++++ 3 files changed, 20 insertions(+) diff --git a/src/cli/cli_srp_client.cpp b/src/cli/cli_srp_client.cpp index 58c9ef457..30ed8d914 100644 --- a/src/cli/cli_srp_client.cpp +++ b/src/cli/cli_srp_client.cpp @@ -81,6 +81,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * @par * Indicates the current state of auto-start mode (enabled or disabled). * @sa otSrpClientIsAutoStartModeEnabled + * @sa @srp */ if (aArgs[0].IsEmpty()) { @@ -160,6 +161,7 @@ exit: * @par * Gets or enables/disables printing callback events from the SRP client. * @sa otSrpClientSetCallback + * @sa @srp */ template <> otError SrpClient::Process(Arg aArgs[]) { @@ -212,6 +214,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * @par * Gets or sets the host name of the SRP client. * @sa otSrpClientSetHostName + * @sa @srp */ else if (aArgs[0] == "name") { @@ -286,6 +289,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * Indicates whether auto address mode is enabled. If auto address mode is not * enabled, then the list of SRP client host addresses is returned. * @sa otSrpClientGetHostInfo + * @sa @srp */ if (aArgs[1].IsEmpty()) { @@ -329,6 +333,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * addresses. * @sa otSrpClientEnableAutoHostAddress * @sa otSrpClientSetHostAddresses + * @sa @srp */ else if (aArgs[1] == "auto") { @@ -385,6 +390,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * Removes SRP client host information and all services from the SRP server. * @sa otSrpClientRemoveHostAndServices * @sa otSrpClientSetHostName + * @sa @srp */ else if (aArgs[0] == "remove") { @@ -492,6 +498,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * that is being used by the SRP client. If the client is not running, the address * is unspecified (all zeros) with a port number of 0. * @sa otSrpClientGetServerAddress + * @sa @srp */ if (aArgs[0].IsEmpty()) { @@ -579,6 +586,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * @par * Adds a service with a given instance name, service name, and port number. * @sa otSrpClientAddService + * @sa @srp */ else if (aArgs[0] == "add") { @@ -654,6 +662,7 @@ template <> otError SrpClient::Process(Arg aArgs[]) * This command is intended for testing only, and requires that * `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` be enabled. * @sa otSrpClientIsServiceKeyRecordEnabled + * @sa @srp */ else if (aArgs[0] == "key") { @@ -846,6 +855,7 @@ void SrpClient::OutputService(uint8_t aIndentSize, const otSrpClientService &aSe * @par * Starts the SRP client operation. * @sa otSrpClientStart + * @sa @srp */ template <> otError SrpClient::Process(Arg aArgs[]) { @@ -871,6 +881,7 @@ exit: * @endcode * @par api_copy * #otSrpClientIsRunning + * @sa @srp */ template <> otError SrpClient::Process(Arg aArgs[]) { diff --git a/src/cli/cli_srp_server.cpp b/src/cli/cli_srp_server.cpp index 98213d524..1dc6d43c7 100644 --- a/src/cli/cli_srp_server.cpp +++ b/src/cli/cli_srp_server.cpp @@ -117,6 +117,7 @@ template <> otError SrpServer::Process(Arg aArgs[]) * This command requires that `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` be enabled. * @sa otSrpServerIsAutoEnableMode * @sa otSrpServerSetAutoEnableMode + * @sa @srp */ template <> otError SrpServer::Process(Arg aArgs[]) { @@ -174,6 +175,7 @@ template <> otError SrpServer::Process(Arg aArgs[]) * SRP servers are no longer active within the Thread network. * * `running`: The SRP server is active and can handle service registrations. * @sa otSrpServerGetState + * @sa @srp */ template <> otError SrpServer::Process(Arg aArgs[]) { @@ -213,6 +215,7 @@ template <> otError SrpServer::Process(Arg aArgs[]) * @par * Enables or disables the SRP server. * @sa otSrpServerSetEnabled + * @sa @srp */ template <> otError SrpServer::Process(Arg aArgs[]) { @@ -312,6 +315,7 @@ exit: * @sa otSrpServerGetNextHost * @sa otSrpServerHostGetAddresses * @sa otSrpServerHostGetFullName + * @sa @srp */ template <> otError SrpServer::Process(Arg aArgs[]) { @@ -414,6 +418,7 @@ void SrpServer::OutputHostAddresses(const otSrpServerHost *aHost) * @sa otSrpServerServiceGetInstanceName * @sa otSrpServerServiceGetServiceName * @sa otSrpServerServiceGetSubTypeServiceNameAt + * @sa @srp */ template <> otError SrpServer::Process(Arg aArgs[]) { diff --git a/src/cli/cli_tcp.cpp b/src/cli/cli_tcp.cpp index ddfc098db..4f3a8d5c7 100644 --- a/src/cli/cli_tcp.cpp +++ b/src/cli/cli_tcp.cpp @@ -324,6 +324,7 @@ exit: * address and port is referred to as "naming the TCP endpoint." This binds the * endpoint for communication. * @sa otTcpBind + * @sa @tcp */ template <> otError TcpExample::Process(Arg aArgs[]) { @@ -369,6 +370,7 @@ exit: * If the connection establishment is successful, the resulting TCP connection * is associated with the example TCP endpoint. * @sa otTcpConnect + * @sa @tcp */ template <> otError TcpExample::Process(Arg aArgs[]) { @@ -449,6 +451,7 @@ exit: * @par * Sends data over the TCP connection associated with the example TCP endpoint * that is provided with the `tcp` CLI. + * @sa @tcp */ template <> otError TcpExample::Process(Arg aArgs[]) { @@ -683,6 +686,7 @@ exit: * Uses the example TCP listener to listen for incoming connections on the * specified IPv6 address and port. * @sa otTcpListen + * @sa @tcp */ template <> otError TcpExample::Process(Arg aArgs[]) {