ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-09-29 05:17:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve doxygen documentation

Browse Source
This commit is contained in:
Henrik Stickann
2022-05-08 03:11:12 +02:00
parent 5caeef64a2
commit 75ef8a9dc6
9 changed files with 156 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/sta/intf/uart.hpp
View File

@@ -1,4 +1,5 @@
/**
* @file
* @brief UART interface definition.
*/
#ifndef STA_INTF_UART_HPP
@@ -11,13 +12,13 @@
namespace sta
{
/**
* @brief Interface for UART.
* @brief Interface for %UART.
*/
class UART
{
public:
/**
* @brief Write buffer to UART.
* @brief Write buffer to %UART.
*
* @param buffer Source buffer
* @param size Number of bytes in buffer
@@ -25,19 +26,19 @@ namespace sta
virtual void write(const uint8_t * buffer, size_t size) = 0;
/**
* @brief Write unsigned integer to UART.
* @brief Write unsigned integer to %UART.
*
* @param value Unsigned integer value
*/
void write(uint8_t value);
/**
* @brief Write unsigned integer to UART.
* @brief Write unsigned integer to %UART.
*
* @param value Unsigned integer value
*/
void write(uint16_t value);
/**
* @brief Write unsigned integer to UART.
* @brief Write unsigned integer to %UART.
*
* @param value Unsigned integer value
*/