From c90f5f3f3e977801f78e011e60dff8b88c376ef6 Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Wed, 20 May 2020 11:21:26 -0700 Subject: [PATCH] [network-diagnostic] add method documentation for GetNextDiagTlv (#4992) --- src/core/thread/network_diagnostic.hpp | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/core/thread/network_diagnostic.hpp b/src/core/thread/network_diagnostic.hpp index 2f6bf52de..97509c27e 100644 --- a/src/core/thread/network_diagnostic.hpp +++ b/src/core/thread/network_diagnostic.hpp @@ -100,6 +100,19 @@ public: */ otError SendDiagnosticReset(const Ip6::Address &aDestination, const uint8_t aTlvTypes[], uint8_t aCount); + /** + * This static method gets the next Network Diagnostic TLV in a given message. + * + * @param[in] aMessage A message. + * @param[inout] aIterator The Network Diagnostic iterator. To get the first TLV it should be set to + * OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT. + * @param[out] aNetworkDiagTlv A reference to a Network Diagnostic TLV to output the next TLV. + * + * @retval OT_ERROR_NONE Successfully found the next Network Diagnostic TLV. + * @retval OT_ERROR_NOT_FOUND No subsequent Network Diagnostic TLV exists in the message. + * @retval OT_ERROR_PARSE Parsing the next Network Diagnostic failed. + * + */ static otError GetNextDiagTlv(const Coap::Message & aMessage, otNetworkDiagIterator &aIterator, otNetworkDiagTlv & aNetworkDiagTlv);