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

@@ -20,6 +20,11 @@ namespace sta
GPIO_INPUT
};
/**
* @brief A wrapper class for Raspi GPIO pins.
*
* @ingroup sta_core_raspi
*/
class RaspiGpioPin : public GpioPin
{
public:
@@ -29,10 +34,21 @@ namespace sta
*/
RaspiGpioPin(uint8_t pin, GpioMode mode);
/**
* @brief Set the state of the GPIO pin.
*
* @param state The state of the GPIO pin. Either HIGH or LOW
*/
void setState(GpioPinState state) override;
/**
* @brief Get the state of the GPIO pin.
*
* @return The state of the GPIO pin. Either HIGH or LOW
*/
GpioPinState getState() override;
/// @brief Dummy GPIO pin
static RaspiGpioPin * DUMMY_GPIO;
private:

View File

@@ -5,4 +5,10 @@
#include <stdio.h>
#include <sys/ioctl.h>
/**
* @defgroup sta_core_raspi Raspi
* @ingroup sta_core_platforms
* @brief Modules implemented for the Raspi platform.
*/
#endif //STA_CORE_RASPI_HAL_HPP