mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git
synced 2025-08-02 17:31:53 +00:00
Rework doxygen comments
This commit is contained in:
parent
ccb15a640e
commit
b2ae487b76
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief GPIO pin interface definitions.
|
||||||
|
*/
|
||||||
#ifndef STA_GPIO_PIN_HPP
|
#ifndef STA_GPIO_PIN_HPP
|
||||||
#define STA_GPIO_PIN_HPP
|
#define STA_GPIO_PIN_HPP
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
* @brief Implementations for SpiInterface and SpiDevice using HAL.
|
* @brief Implementations for `SpiInterface` and `SpiDevice` using HAL.
|
||||||
*
|
*
|
||||||
* Define **STA_HAL_SPI_ENABLE** in `<sta/config.hpp>` to enable module.
|
* Define **STA_HAL_SPI_ENABLE** in `<sta/config.hpp>` to enable module.
|
||||||
*
|
*
|
||||||
@ -24,7 +24,7 @@
|
|||||||
namespace sta
|
namespace sta
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @brief Implementation of SpiInterface using HAL.
|
* @brief Implementation of `SpiInterface` interface using HAL.
|
||||||
*/
|
*/
|
||||||
class HalSpiInterface : public SpiInterface
|
class HalSpiInterface : public SpiInterface
|
||||||
{
|
{
|
||||||
@ -51,7 +51,7 @@ namespace sta
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Implementation of SpiDevice using HAL.
|
* @brief Implementation of `SpiDevice` interface using HAL.
|
||||||
*/
|
*/
|
||||||
class HalSpiDevice : public SpiDevice
|
class HalSpiDevice : public SpiDevice
|
||||||
{
|
{
|
||||||
|
@ -20,7 +20,7 @@
|
|||||||
namespace sta
|
namespace sta
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @brief Implementation of UART for HAL.
|
* @brief Implementation of `UART` interface using HAL.
|
||||||
*/
|
*/
|
||||||
class HalUART : public UART
|
class HalUART : public UART
|
||||||
{
|
{
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief Mutex interface definition.
|
||||||
|
*/
|
||||||
#ifndef STA_MUTEX_HPP
|
#ifndef STA_MUTEX_HPP
|
||||||
#define STA_MUTEX_HPP
|
#define STA_MUTEX_HPP
|
||||||
|
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief Signal interface definition.
|
||||||
|
*/
|
||||||
#ifndef STA_SIGNAL_HPP
|
#ifndef STA_SIGNAL_HPP
|
||||||
#define STA_SIGNAL_HPP
|
#define STA_SIGNAL_HPP
|
||||||
|
|
||||||
@ -5,7 +8,7 @@
|
|||||||
namespace sta
|
namespace sta
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @brief Signal interface
|
* @brief Interface for signal objects.
|
||||||
*/
|
*/
|
||||||
class Signal
|
class Signal
|
||||||
{
|
{
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief SPI interface definitions.
|
||||||
|
*/
|
||||||
#ifndef STA_SPI_DEVICE_HPP
|
#ifndef STA_SPI_DEVICE_HPP
|
||||||
#define STA_SPI_DEVICE_HPP
|
#define STA_SPI_DEVICE_HPP
|
||||||
|
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief SPI interface definitions.
|
||||||
|
*/
|
||||||
#ifndef STA_SPI_INTERFACE_HPP
|
#ifndef STA_SPI_INTERFACE_HPP
|
||||||
#define STA_SPI_INTERFACE_HPP
|
#define STA_SPI_INTERFACE_HPP
|
||||||
|
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @brief UART interface definition.
|
||||||
|
*/
|
||||||
#ifndef STA_UART_HPP
|
#ifndef STA_UART_HPP
|
||||||
#define STA_UART_HPP
|
#define STA_UART_HPP
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user