From a5f44b858035d2d931ee79c622dfe7ab11c3a7f9 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 23 Mar 2021 14:25:50 +0100 Subject: [PATCH] doc updatedoc updatedd --- osal/common/UdpTcPollingTask.h | 9 ++------- osal/common/UdpTmTcBridge.h | 4 ++++ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/osal/common/UdpTcPollingTask.h b/osal/common/UdpTcPollingTask.h index ae1c4c442..052eced52 100644 --- a/osal/common/UdpTcPollingTask.h +++ b/osal/common/UdpTcPollingTask.h @@ -9,13 +9,8 @@ #include /** - * @brief This class can be used to implement the polling of a Unix socket, - * using UDP for now. - * @details - * The task will be blocked while the specified number of bytes has not been - * received, so TC reception is handled inside a separate task. - * This class caches the IP address of the sender. It is assumed there - * is only one sender for now. + * @brief This class should be used with the UdpTmTcBridge to implement a UDP server + * for receiving and sending PUS TMTC. */ class UdpTcPollingTask: public TcpIpBase, diff --git a/osal/common/UdpTmTcBridge.h b/osal/common/UdpTmTcBridge.h index 6f38034e9..8b8d19491 100644 --- a/osal/common/UdpTmTcBridge.h +++ b/osal/common/UdpTmTcBridge.h @@ -16,6 +16,10 @@ #include +/** + * @brief This class should be used with the UdpTcPollingTask to implement a UDP server + * for receiving and sending PUS TMTC. + */ class UdpTmTcBridge: public TmTcBridge, public TcpIpBase {