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] add @moreinfo Doxygen tags to reference CoAPS Concepts Guide (#9867)

Browse Source
This commit is contained in:
jrhodie
2024-02-26 10:25:13 -08:00
committed by GitHub
parent 41d05c2a98
commit ac417bdee7
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/cli_coap_secure.cpp
+11 -8
View File
@@ -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<Cmd("resource")>(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<Cmd("set")>(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<Cmd("stop")>(Arg aArgs[])
@@ -289,7 +289,7 @@ template <> otError CoapSecure::Process<Cmd("stop")>(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<Cmd("isclosed")>(Arg aArgs[])
@@ -305,7 +305,7 @@ template <> otError CoapSecure::Process<Cmd("isclosed")>(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<Cmd("isconnected")>(Arg aArgs[])
@@ -323,6 +323,7 @@ template <> otError CoapSecure::Process<Cmd("isconnected")>(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<Cmd("isconnactive")>(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<Cmd("get")>(Arg aArgs[]) { return ProcessRequest(aArgs, OT_COAP_CODE_GET); }
@@ -393,7 +395,7 @@ template <> otError CoapSecure::Process<Cmd("get")>(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<Cmd("post")>(Arg aArgs[]) { return ProcessRequest(aArgs, OT_COAP_CODE_POST); }
@@ -425,7 +427,7 @@ template <> otError CoapSecure::Process<Cmd("post")>(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<Cmd("put")>(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<Cmd("connect")>(Arg aArgs[])