Updated: Doxygen Documentation

This commit is contained in:
@CarlWachter
2024-01-06 17:17:40 +01:00
committed by CarlWachter
parent b3ed26e288
commit 16b9e6135c
26 changed files with 331 additions and 306 deletions

View File

@@ -3,8 +3,18 @@
#include <stdint.h>
/**
* @defgroup sta_core_uart UART
* @ingroup sta_core
* @brief UART interface.
*/
namespace sta
{
/**
* @brief UART modes of operation.
*/
enum class UARTMode
{
RX,
@@ -13,10 +23,11 @@ namespace sta
};
/**
* @brief %UART settings.
* @brief UART settings.
*/
struct UARTSettings
{
/// @brief Mode of operation.
UARTMode mode;
};
} // namespace sta

View File

@@ -6,6 +6,11 @@
namespace sta
{
/**
* @brief UART interface.
*
* @ingroup sta_core_uart
*/
class UART : public Interface
{
public: