From 72c369ced30b9059f22155f37fbcb2b1deba0620 Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Wed, 3 Jun 2020 16:06:46 -0700 Subject: [PATCH] [udp6] add method documentation for GetUdpSockets() (#5044) --- src/core/net/udp6.hpp | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/core/net/udp6.hpp b/src/core/net/udp6.hpp index e48496fa5..610332d57 100644 --- a/src/core/net/udp6.hpp +++ b/src/core/net/udp6.hpp @@ -321,7 +321,13 @@ public: void UpdateChecksum(Message &aMessage, uint16_t aChecksum); #if OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE - otUdpSocket *GetUdpSockets(void) { return mSockets.GetHead(); } + /** + * This method returns the head of UDP Sockets list. + * + * @returns A pointer to the head of UDP Socket linked list. + * + */ + UdpSocket *GetUdpSockets(void) { return mSockets.GetHead(); } #endif #if OPENTHREAD_CONFIG_UDP_FORWARD_ENABLE @@ -337,7 +343,7 @@ public: mUdpForwarder = aForwarder; mUdpForwarderContext = aContext; } -#endif // OPENTHREAD_CONFIG_UDP_FORWARD_ENABLE +#endif private: enum