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

@@ -22,7 +22,7 @@
#define INC_ADCDEVICE_H_
/**
* ADCDevice implementation
* %ADCDevice implementation
* \defgroup ADCDevice Package ADCDevice
* \ingroup HAL
* @{

View File

@@ -21,7 +21,7 @@
#define INC_BUZZER_H_
/**
* Buzzer implementation
* %Buzzer implementation
* \defgroup Buzzer Package Buzzer
* \ingroup HAL
* @{

View File

@@ -21,7 +21,7 @@
#define _CACHEDEEPROM_H_
/**
* CachedStorage implementation
* %CachedStorage implementation
* \defgroup CachedStorage Package CachedStorage
* \ingroup HAL
* @{

View File

@@ -21,7 +21,7 @@
#define SOLENOID_H_
/**
* CoverSolenoid implementation
* %CoverSolenoid implementation
* \defgroup CoverSolenoid Package CoverSolenoid
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DACDevice implementation
* %DACDevice implementation
* \defgroup DACDevice Package DACDevice
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DisplayDevice implementation
* %DisplayDevice implementation
* \defgroup DisplayDevice Package DisplayDevice
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* HighVoltageDetection implementation
* %HighVoltageDetection implementation
* \defgroup HighVoltageDetection Package HighVoltageDetection
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* IODevice implementation
* %IODevice implementation
* \defgroup IODevice Package IODevice
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Interlock implementation
* %Interlock implementation
* \defgroup Interlock Package Interlock
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* KeyboardDevice implementation
* %KeyboardDevice implementation
* \defgroup KeyboardDevice Package KeyboardDevice
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Leds implementation
* %Leds implementation
* \defgroup Leds Package Leds
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Logger implementation
* %Logger implementation
* \defgroup Logger Package Logger
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MAX5715 implementation
* %MAX5715 implementation
* \defgroup MAX5715 Package MAX5715
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MemoryDevice implementation
* %MemoryDevice implementation
* \defgroup MemoryDevice Package MemoryDevice
* \ingroup HAL
* @{

View File

@@ -17,7 +17,7 @@
*/
/**
* Observable implementation
* %Observable implementation
* \defgroup Observable Package Observable
* \ingroup HAL
* @{

View File

@@ -17,7 +17,7 @@
*/
/**
* Observer implementation
* %Observer implementation
* \defgroup Observer Package Observer
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* PID implementation
* %PID implementation
* \defgroup PID Package PID
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* TeslaGunSafety implementation
* %TeslaGunSafety implementation
* \defgroup TeslaGunSafety Package TeslaGunSafety
* \ingroup HAL
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* CRC32 implementation
* %CRC32 implementation
* \defgroup CRC32 Package CRC32
* \ingroup HAL
* @{

View File

@@ -18,8 +18,8 @@
// -----------------------------------------------------------------------------
/**
* nhd0420 implementation
* \defgroup nhd0420 Package nhd0420
* %NHD0420 implementation
* \defgroup NHD0420 Package NHD0420
* \ingroup HAL
* @{
*/
@@ -118,9 +118,13 @@
// Type definitions.
// -----------------------------------------------------------------------------
/**
* \class NHD0420
* \extends DisplayDevice
*/
struct NHD0420
{
struct DisplayDevice displayDevice;
struct DisplayDevice displayDevice; //!< \private
const struct IODevice* device;
bool initialized;
};

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Storm700 implementation
* %Storm700 implementation
* \defgroup Storm700 Package Storm700
* \ingroup HAL
* @{
@@ -48,9 +48,13 @@
// Type definitions.
// -----------------------------------------------------------------------------
/**
* \class Storm700
* \extends KeyboardDevice
*/
struct Storm700
{
struct KeyboardDevice keyboardDevice;
struct KeyboardDevice keyboardDevice; //!< \private
const struct IODevice* device;
bool initialized;
};

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;

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* ADConverter implementation
* %ADConverter implementation
* \defgroup ADConverter Package ADConverter
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* ADConverters implementation
* %ADConverters implementation
* \defgroup ADConverters Package ADConverters
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* CalibrationParameters implementation
* %CalibrationParameters implementation
* \defgroup CalibrationParameters Package CalibrationParameters
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* CalibrationSetpoint implementation
* %CalibrationSetpoint implementation
* \defgroup CalibrationSetpoint Package CalibrationSetpoint
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* CalibrationSetpoints implementation
* %CalibrationSetpoints implementation
* \defgroup CalibrationSetpoints Package CalibrationSetpoints
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DAConverter implementation
* %DAConverter implementation
* \defgroup DAConverter Package DAConverter
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DAConverters implementation
* %DAConverters implementation
* \defgroup DAConverters Package DAConverters
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DeviceParameters implementation
* %DeviceParameters implementation
* \defgroup DeviceParameters Package DeviceParameters
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Display implementation
* %Display implementation
* \defgroup Display Package Display
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* DisplayContent implementation
* %DisplayContent implementation
* \defgroup DisplayContent Package DisplayContent
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Displays implementation
* %Displays implementation
* \defgroup Displays Package Displays
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Error implementation
* %Error implementation
* \defgroup Error Package Error
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* FreeRTOSConfig implementation
* %FreeRTOSConfig implementation
* \defgroup FreeRTOSConfig Package FreeRTOSConfig
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* FreeRTOSFixes implementation
* %FreeRTOSFixes implementation
* \defgroup FreeRTOSFixes Package FreeRTOSFixes
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MenuCore implementation
* %MenuCore implementation
* \defgroup MenuCore Package MenuCore
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MenuElements implementation
* %MenuElements implementation
* \defgroup MenuElements Package MenuElements
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MenuStates implementation
* %MenuStates implementation
* \defgroup MenuStates Package MenuStates
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* MenuText implementation
* %MenuText implementation
* \defgroup MenuText Package MenuText
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* PIDParameters implementation
* %PIDParameters implementation
* \defgroup PIDParameters Package PIDParameters
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* PIN implementation
* %PIN implementation
* \defgroup PIN Package PIN
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* PowerLossDetector implementation
* %PowerLossDetector implementation
* \defgroup PowerLossDetector Package PowerLossDetector
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairPreset implementation
* %RepairPreset implementation
* \defgroup RepairPreset Package RepairPreset
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairPresets implementation
* %RepairPresets implementation
* \defgroup RepairPresets Package RepairPresets
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* SignalProfileGenerator implementation
* %SignalProfileGenerator implementation
* \defgroup SignalProfileGenerator Package SignalProfileGenerator
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Voltage implementation
* %Voltage implementation
* \defgroup Voltage Package Voltage
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* Warning implementation
* %Warning implementation
* \defgroup Warning Package Warning
* \ingroup hsb-mrts
* @{

View File

@@ -18,8 +18,8 @@
// -----------------------------------------------------------------------------
/**
* hsb-mrts implementation
* \defgroup hsb-mrts Package hsb-mrts
* %HSB-MRTS implementation
* \defgroup HSB-MRTS Package HSB-MRTS
* \ingroup hsb-mrts
* @{
*/

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* HwValidationMenu implementation
* %HwValidationMenu implementation
* \defgroup HwValidationMenu Package HwValidationMenu
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairMenu implementation
* %RepairMenu implementation
* \defgroup RepairMenu Package RepairMenu
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairMenus implementation
* %RepairMenus implementation
* \defgroup RepairMenus Package RepairMenus
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairProcess implementation
* %RepairProcess implementation
* \defgroup RepairProcess Package RepairProcess
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairProcessRow implementation
* %RepairProcessRow implementation
* \defgroup RepairProcessRow Package RepairProcessRow
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* RepairProcesses implementation
* %RepairProcesses implementation
* \defgroup RepairProcesses Package RepairProcesses
* \ingroup hsb-mrts
* @{

View File

@@ -18,7 +18,7 @@
// -----------------------------------------------------------------------------
/**
* STM32f10x_it implementation
* %STM32f10x_it implementation
* \defgroup STM32f10x_it Package STM32f10x_it
* \ingroup hsb-mrts
* @{