Doxygen update

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@427 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-15 11:04:24 +00:00
parent 41ebc02741
commit 15ab232e82
67 changed files with 94 additions and 76 deletions

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* CathodeMCP implementation
* %CathodeMCP implementation
* \defgroup CathodeMCP Package CathodeMCP
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* InternalFlash implementation
* %InternalFlash implementation
* \defgroup InternalFlash Package InternalFlash
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Pcba implementation
* %Pcba implementation
* \defgroup Pcba Package Pcba
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Version implementation
* %Version implementation
* \defgroup Version Package Version
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* GPIO implementation
* %GPIO implementation
* \defgroup GPIO Package GPIO
* \ingroup Platform
* @{
@@ -54,9 +54,7 @@ typedef enum
/**
* \class Gpio
* \extends IODevice
* The Gpio struct that can be used as an object
*/
struct Gpio
{
struct IODevice device; //!< \private

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* InternalADC implementation
* %InternalADC implementation
* \defgroup InternalADC Package InternalADC
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Keypad implementation
* %Keypad implementation
* \defgroup Keypad Package Keypad
* \ingroup Platform
* @{
@@ -76,9 +76,13 @@ struct keypadElement
EXTI_InitTypeDef EXTI_InitStruct;
};
/**
* \class Keypad
* \extends IODevice
*/
struct Keypad
{
struct IODevice device;
struct IODevice device; //!< \private
struct keypadElement row[KEYPAD_MAX_NUMBER_OF_ROWS];
struct keypadElement column[KEYPAD_MAX_NUMBER_OF_COLUMNS];
Keypad_KeyState lastState[KEYPAD_MAX_NUMBER_OF_ROWS][KEYPAD_MAX_NUMBER_OF_COLUMNS];

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Platform implementation
* %Platform implementation
* \defgroup PlatformGroup Package Platform
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Rtc implementation
* %Rtc implementation
* \defgroup Rtc Package Rtc
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Spi implementation
* %Spi implementation
* \defgroup Spi Package Spi
* \ingroup Platform
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* SpiDevice implementation
* %SpiDevice implementation
* \defgroup SpiDevice Package SpiDevice
* \ingroup Platform
* @{
@@ -47,9 +47,13 @@
// Type definitions.
// -----------------------------------------------------------------------------
/**
* \class SpiDevice
* \extends IODevice
*/
struct SpiDevice
{
struct IODevice device;
struct IODevice device; //!< \private
struct Spi* spi;
struct SpiParameters parameters;
T_PL_GPIO SPI_CE;

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* UART implementation
* %UART implementation
* \defgroup UART Package UART
* \ingroup Platform
* @{
@@ -75,9 +75,13 @@ struct UartParameters
UBaseType_t rxQueueSize;
};
/**
* \class Uart
* \extends IODevice
*/
struct Uart
{
struct IODevice device;
struct IODevice device; //!< \private
USART_TypeDef* USART_TypeDef;
USART_InitTypeDef USART_InitStruct;
USART_ClockInitTypeDef* USART_ClockInitStruct;