From b2ae487b76036fba3ae23ea0401fe8fb133460ba Mon Sep 17 00:00:00 2001
From: Henrik Stickann <4376396-Mithradir@users.noreply.gitlab.com>
Date: Tue, 12 Apr 2022 16:38:19 +0200
Subject: [PATCH] Rework doxygen comments

---
 include/sta/gpio_pin.hpp      | 3 +++
 include/sta/hal/spi.hpp       | 6 +++---
 include/sta/hal/uart.hpp      | 2 +-
 include/sta/mutex.hpp         | 3 +++
 include/sta/signal.hpp        | 5 ++++-
 include/sta/spi_device.hpp    | 3 +++
 include/sta/spi_interface.hpp | 3 +++
 include/sta/uart.hpp          | 3 +++
 8 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/include/sta/gpio_pin.hpp b/include/sta/gpio_pin.hpp
index a0cac2e..d976d4b 100644
--- a/include/sta/gpio_pin.hpp
+++ b/include/sta/gpio_pin.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief GPIO pin interface definitions.
+ */
 #ifndef STA_GPIO_PIN_HPP
 #define STA_GPIO_PIN_HPP
 
diff --git a/include/sta/hal/spi.hpp b/include/sta/hal/spi.hpp
index f298541..a342f12 100644
--- a/include/sta/hal/spi.hpp
+++ b/include/sta/hal/spi.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.
  *
@@ -24,7 +24,7 @@
 namespace sta
 {
 	/**
-	 * @brief Implementation of SpiInterface using HAL.
+	 * @brief Implementation of `SpiInterface` interface using HAL.
 	 */
 	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
 	{
diff --git a/include/sta/hal/uart.hpp b/include/sta/hal/uart.hpp
index e8e5434..c12c5dc 100644
--- a/include/sta/hal/uart.hpp
+++ b/include/sta/hal/uart.hpp
@@ -20,7 +20,7 @@
 namespace sta
 {
 	/**
-	 * @brief Implementation of UART for HAL.
+	 * @brief Implementation of `UART` interface using HAL.
 	 */
 	class HalUART : public UART
 	{
diff --git a/include/sta/mutex.hpp b/include/sta/mutex.hpp
index a9869de..bfc04a5 100644
--- a/include/sta/mutex.hpp
+++ b/include/sta/mutex.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief Mutex interface definition.
+ */
 #ifndef STA_MUTEX_HPP
 #define STA_MUTEX_HPP
 
diff --git a/include/sta/signal.hpp b/include/sta/signal.hpp
index e32a204..b38abf3 100644
--- a/include/sta/signal.hpp
+++ b/include/sta/signal.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief Signal interface definition.
+ */
 #ifndef STA_SIGNAL_HPP
 #define STA_SIGNAL_HPP
 
@@ -5,7 +8,7 @@
 namespace sta
 {
 	/**
-	 * @brief Signal interface
+	 * @brief Interface for signal objects.
 	 */
 	class Signal
 	{
diff --git a/include/sta/spi_device.hpp b/include/sta/spi_device.hpp
index f1a4833..377beae 100644
--- a/include/sta/spi_device.hpp
+++ b/include/sta/spi_device.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief SPI interface definitions.
+ */
 #ifndef STA_SPI_DEVICE_HPP
 #define STA_SPI_DEVICE_HPP
 
diff --git a/include/sta/spi_interface.hpp b/include/sta/spi_interface.hpp
index 8cdc4d0..5708b89 100644
--- a/include/sta/spi_interface.hpp
+++ b/include/sta/spi_interface.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief SPI interface definitions.
+ */
 #ifndef STA_SPI_INTERFACE_HPP
 #define STA_SPI_INTERFACE_HPP
 
diff --git a/include/sta/uart.hpp b/include/sta/uart.hpp
index 42068fc..8680d09 100644
--- a/include/sta/uart.hpp
+++ b/include/sta/uart.hpp
@@ -1,3 +1,6 @@
+/**
+ * @brief UART interface definition.
+ */
 #ifndef STA_UART_HPP
 #define STA_UART_HPP