From ac417bdee7f5143aeb3b619fa899c9c84770bf61 Mon Sep 17 00:00:00 2001 From: jrhodie <139580534+jrhodie@users.noreply.github.com> Date: Mon, 26 Feb 2024 10:25:13 -0800 Subject: [PATCH] [cli] add `@moreinfo` Doxygen tags to reference CoAPS Concepts Guide (#9867) --- src/cli/cli_coap_secure.cpp | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/src/cli/cli_coap_secure.cpp b/src/cli/cli_coap_secure.cpp index c1bacdb62..e238fbbd0 100644 --- a/src/cli/cli_coap_secure.cpp +++ b/src/cli/cli_coap_secure.cpp @@ -103,7 +103,7 @@ void CoapSecure::PrintPayload(otMessage *aMessage) * @endcode * @cparam coaps resource [@ca{uri-path}] * @par - * Gets or sets the URI path of the CoAPS server resource. + * Gets or sets the URI path of the CoAPS server resource. @moreinfo{@coaps}. * @sa otCoapSecureAddBlockWiseResource */ template <> otError CoapSecure::Process(Arg aArgs[]) @@ -152,7 +152,7 @@ exit: * @endcode * @cparam coaps set @ca{new-content} * @par - * Sets the content sent by the resource on the CoAPS server. + * Sets the content sent by the resource on the CoAPS server. @moreinfo{@coaps}. */ template <> otError CoapSecure::Process(Arg aArgs[]) { @@ -207,7 +207,7 @@ exit: * `check-peer-cert` is `true`, and the `max-conn-attempts` value is the * number specified in the argument. * @par - * Starts the CoAP Secure service. + * Starts the CoAP Secure service. @moreinfo{@coaps}. * @sa otCoapSecureStart * @sa otCoapSecureSetSslAuthMode * @sa otCoapSecureSetClientConnectedCallback @@ -255,7 +255,7 @@ exit: * Done * @endcode * @par - * Stops the CoAP Secure service. + * Stops the CoAP Secure service. @moreinfo{@coaps}. * @sa otCoapSecureStop */ template <> otError CoapSecure::Process(Arg aArgs[]) @@ -289,7 +289,7 @@ template <> otError CoapSecure::Process(Arg aArgs[]) * Done * @endcode * @par - * Indicates if the CoAP Secure service is closed. + * Indicates if the CoAP Secure service is closed. @moreinfo{@coaps}. * @sa otCoapSecureIsClosed */ template <> otError CoapSecure::Process(Arg aArgs[]) @@ -305,7 +305,7 @@ template <> otError CoapSecure::Process(Arg aArgs[]) * Done * @endcode * @par - * Indicates if the CoAP Secure service is connected. + * Indicates if the CoAP Secure service is connected. @moreinfo{@coaps}. * @sa otCoapSecureIsConnected */ template <> otError CoapSecure::Process(Arg aArgs[]) @@ -323,6 +323,7 @@ template <> otError CoapSecure::Process(Arg aArgs[]) * @par * Indicates if the CoAP Secure service connection is active * (either already connected or in the process of establishing a connection). + * @moreinfo{@coaps}. * @sa otCoapSecureIsConnectionActive */ template <> otError CoapSecure::Process(Arg aArgs[]) @@ -362,6 +363,7 @@ exit: * `block-256`, `block-512`, or `block-1024`. * @par * Gets information about the specified CoAPS resource on the CoAPS server. + * @moreinfo{@coaps}. */ template <> otError CoapSecure::Process(Arg aArgs[]) { return ProcessRequest(aArgs, OT_COAP_CODE_GET); } @@ -393,7 +395,7 @@ template <> otError CoapSecure::Process(Arg aArgs[]) { return Proces * integer that specifies the number of blocks to send. The `block-` type * requires `OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE` to be set. * @par - * Creates the specified CoAPS resource. + * Creates the specified CoAPS resource. @moreinfo{@coaps}. */ template <> otError CoapSecure::Process(Arg aArgs[]) { return ProcessRequest(aArgs, OT_COAP_CODE_POST); } @@ -425,7 +427,7 @@ template <> otError CoapSecure::Process(Arg aArgs[]) { return Proce * integer that specifies the number of blocks to send. The `block-` type * requires `OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE` to be set. * @par - * Modifies the specified CoAPS resource. + * Modifies the specified CoAPS resource. @moreinfo{@coaps}. */ template <> otError CoapSecure::Process(Arg aArgs[]) { return ProcessRequest(aArgs, OT_COAP_CODE_PUT); } @@ -610,6 +612,7 @@ exit: * The `address` parameter is the IPv6 address of the peer. * @par * Initializes a Datagram Transport Layer Security (DTLS) session with a peer. + * @moreinfo{@coaps}. * @sa otCoapSecureConnect */ template <> otError CoapSecure::Process(Arg aArgs[])