[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
This commit is contained in:
jrhodie
2023-12-11 15:28:40 -08:00
committed by GitHub
parent 879fdfa12b
commit 12af023121
3 changed files with 20 additions and 0 deletions
+11
View File
@@ -81,6 +81,7 @@ template <> otError SrpClient::Process<Cmd("autostart")>(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<Cmd("callback")>(Arg aArgs[])
{
@@ -212,6 +214,7 @@ template <> otError SrpClient::Process<Cmd("host")>(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<Cmd("host")>(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<Cmd("host")>(Arg aArgs[])
* addresses.
* @sa otSrpClientEnableAutoHostAddress
* @sa otSrpClientSetHostAddresses
* @sa @srp
*/
else if (aArgs[1] == "auto")
{
@@ -385,6 +390,7 @@ template <> otError SrpClient::Process<Cmd("host")>(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<Cmd("server")>(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<Cmd("service")>(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<Cmd("service")>(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<Cmd("start")>(Arg aArgs[])
{
@@ -871,6 +881,7 @@ exit:
* @endcode
* @par api_copy
* #otSrpClientIsRunning
* @sa @srp
*/
template <> otError SrpClient::Process<Cmd("state")>(Arg aArgs[])
{
+5
View File
@@ -117,6 +117,7 @@ template <> otError SrpServer::Process<Cmd("addrmode")>(Arg aArgs[])
* This command requires that `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` be enabled.
* @sa otSrpServerIsAutoEnableMode
* @sa otSrpServerSetAutoEnableMode
* @sa @srp
*/
template <> otError SrpServer::Process<Cmd("auto")>(Arg aArgs[])
{
@@ -174,6 +175,7 @@ template <> otError SrpServer::Process<Cmd("domain")>(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<Cmd("state")>(Arg aArgs[])
{
@@ -213,6 +215,7 @@ template <> otError SrpServer::Process<Cmd("enable")>(Arg aArgs[])
* @par
* Enables or disables the SRP server.
* @sa otSrpServerSetEnabled
* @sa @srp
*/
template <> otError SrpServer::Process<Cmd("disable")>(Arg aArgs[])
{
@@ -312,6 +315,7 @@ exit:
* @sa otSrpServerGetNextHost
* @sa otSrpServerHostGetAddresses
* @sa otSrpServerHostGetFullName
* @sa @srp
*/
template <> otError SrpServer::Process<Cmd("host")>(Arg aArgs[])
{
@@ -414,6 +418,7 @@ void SrpServer::OutputHostAddresses(const otSrpServerHost *aHost)
* @sa otSrpServerServiceGetInstanceName
* @sa otSrpServerServiceGetServiceName
* @sa otSrpServerServiceGetSubTypeServiceNameAt
* @sa @srp
*/
template <> otError SrpServer::Process<Cmd("service")>(Arg aArgs[])
{
+4
View File
@@ -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<Cmd("bind")>(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<Cmd("connect")>(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<Cmd("send")>(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<Cmd("listen")>(Arg aArgs[])
{