diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/CathodeMCP.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/CathodeMCP.h index 16eb8dc..71c4fd4 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/CathodeMCP.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/CathodeMCP.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file CathodeMCP.h -/// @ingroup {group_name} +/** + * CathodeMCP implementation + * \defgroup CathodeMCP Package CathodeMCP + * \ingroup Platform + * @{ + */ #ifndef CATHODEMCP_H_ #define CATHODEMCP_H_ @@ -108,3 +109,5 @@ extern void CathodeMCP_switchToCathode(void); extern void CathodeMCP_switchToMCP(void); #endif /* CATHODEMCP_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/InternalFlash.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/InternalFlash.h index 994d3f0..c477f2f 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/InternalFlash.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/InternalFlash.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file InternalFlash.h -/// @ingroup {group_name} +/** + * InternalFlash implementation + * \defgroup InternalFlash Package InternalFlash + * \ingroup Platform + * @{ + */ #ifndef INC_INTERNALFLASH_H_ #define INC_INTERNALFLASH_H_ @@ -142,3 +143,5 @@ extern ErrorStatus InternalFlash_read(const struct InternalFlash* self, uint32_t extern ErrorStatus InternalFlash_erasePage(const struct InternalFlash* self, unsigned int page); #endif /* INC_INTERNALFLASH_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/PCBA.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/PCBA.h index a2b993d..ad766c3 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/PCBA.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/PCBA.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file PCBA.h -/// @ingroup {group_name} +/** + * Pcba implementation + * \defgroup Pcba Package Pcba + * \ingroup Platform + * @{ + */ #ifndef PCBA_H_ #define PCBA_H_ @@ -98,3 +99,5 @@ extern struct Pcba* PCBA_getInstance(void); extern ErrorStatus PCBA_setIO(T_PL_GPIO* A0, T_PL_GPIO* A1); #endif /* PCBA_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/Version.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/Version.h index b323935..131ec76 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/Version.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/Version.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file Version.h -/// @ingroup {group_name} +/** + * Version implementation + * \defgroup Version Package Version + * \ingroup Platform + * @{ + */ #ifndef INC_VERSION_H_ #define INC_VERSION_H_ @@ -75,3 +76,5 @@ struct Version extern struct Version* Version_getInstance(void); #endif /* INC_VERSION_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h index 9f13ce7..5410bf1 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file gpio.h -/// @ingroup {group_name} +/** + * GPIO implementation + * \defgroup GPIO Package GPIO + * \ingroup Platform + * @{ + */ #ifndef INC_GPIO_H_ #define INC_GPIO_H_ @@ -118,3 +119,5 @@ extern ErrorStatus GPIO_setValue(struct Gpio* self, bool value); extern ErrorStatus GPIO_getValue(struct Gpio* self, bool* value); #endif /* INC_GPIO_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/internalADC.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/internalADC.h index 9a1e398..ded01da 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/internalADC.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/internalADC.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file adc.h -/// @ingroup {group_name} +/** + * InternalADC implementation + * \defgroup InternalADC Package InternalADC + * \ingroup Platform + * @{ + */ #ifndef INC_ADC_H_ #define INC_ADC_H_ @@ -234,3 +235,5 @@ extern void ADCChannel_destruct(struct AdcChannel* self); extern ErrorStatus ADCChannel_read(const struct AdcChannel* self, uint16_t* value); #endif /* INC_ADC_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/keypadMatrix.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/keypadMatrix.h index 3c40502..5591714 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/keypadMatrix.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/keypadMatrix.h @@ -17,11 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file keypadMatrix.h -/// @ingroup {group_name} +/** + * Keypad implementation + * \defgroup Keypad Package Keypad + * \ingroup Platform + * @{ + */ #ifndef KEYPAD_INC_KEYPADMATRIX_H_ @@ -134,3 +135,5 @@ extern void Keypad_destruct (const struct Keypad* self); #endif /* KEYPAD_INC_KEYPADMATRIX_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/platform.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/platform.h index 06611a9..656359a 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/platform.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/platform.h @@ -17,13 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {HAL} {group_description} -/// This file defines the properties for the Olimex STM32 H107 dev-kit -/// platform. -/// - -/// @file olx_stm32_h107.h -/// @ingroup {HAL} +/** + * Platform implementation + * \defgroup PlatformGroup Package Platform + * \ingroup Platform + * @{ + */ #ifndef PLATFORM_INC_PLATFORM_H_ @@ -138,3 +137,5 @@ extern ErrorStatus initPlatform(void); extern ErrorStatus destructPlatform(void); #endif /* PLATFORM_INC_PLATFORM_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h index 736abd3..1508827 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file rtc.h -/// @ingroup {group_name} +/** + * Rtc implementation + * \defgroup Rtc Package Rtc + * \ingroup Platform + * @{ + */ #ifndef INC_RTC_H_ #define INC_RTC_H_ @@ -94,3 +95,5 @@ extern void RTC_calculateTimeFromSeconds(uint32_t seconds, struct Time* time); #endif /* INC_RTC_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spi.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spi.h index 3b93111..b921d6d 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spi.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spi.h @@ -17,11 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file spi.h -/// @ingroup {group_name} +/** + * Spi implementation + * \defgroup Spi Package Spi + * \ingroup Platform + * @{ + */ #ifndef MISC_INC_SPI_H_ @@ -150,3 +151,5 @@ extern ErrorStatus SPI_getDefaultParameters(struct SpiParameters* parameters); #endif /* MISC_INC_SPI_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spiDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spiDevice.h index fc1f2e8..04ce27e 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spiDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spiDevice.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file spiDevice.h -/// @ingroup {group_name} +/** + * SpiDevice implementation + * \defgroup SpiDevice Package SpiDevice + * \ingroup Platform + * @{ + */ #ifndef PLATFORM_INC_SPIDEVICE_H_ #define PLATFORM_INC_SPIDEVICE_H_ @@ -79,3 +80,5 @@ extern ErrorStatus SpiDevice_construct(struct SpiDevice* self, struct Spi* spi, extern ErrorStatus SpiDevice_write (const struct SpiDevice* self, const char* buffer, int length); #endif /* PLATFORM_INC_SPIDEVICE_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/uart.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/uart.h index 1956fee..10f295e 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/uart.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/uart.h @@ -17,11 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file uart.h -/// @ingroup {group_name} +/** + * UART implementation + * \defgroup UART Package UART + * \ingroup Platform + * @{ + */ #ifndef MISC_INC_UART_H_ @@ -167,3 +168,5 @@ extern ErrorStatus Uart_read(struct Uart* self, char* buffer, size_t length, siz #endif /* MISC_INC_UART_H_ */ + +/** @} */