private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More doxygen documentation

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@419 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-11 14:56:48 +00:00
parent 33bbbf4827
commit 20885c64e8
12 changed files with 96 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/CathodeMCP.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * CathodeMCP implementation
* \defgroup CathodeMCP Package CathodeMCP
/// @file CathodeMCP.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef CATHODEMCP_H_ #ifndef CATHODEMCP_H_
#define CATHODEMCP_H_ #define CATHODEMCP_H_
@@ -108,3 +109,5 @@ extern void CathodeMCP_switchToCathode(void);
extern void CathodeMCP_switchToMCP(void); extern void CathodeMCP_switchToMCP(void);
#endif /* CATHODEMCP_H_ */ #endif /* CATHODEMCP_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/InternalFlash.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * InternalFlash implementation
* \defgroup InternalFlash Package InternalFlash
/// @file InternalFlash.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef INC_INTERNALFLASH_H_ #ifndef INC_INTERNALFLASH_H_
#define 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); extern ErrorStatus InternalFlash_erasePage(const struct InternalFlash* self, unsigned int page);
#endif /* INC_INTERNALFLASH_H_ */ #endif /* INC_INTERNALFLASH_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/PCBA.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Pcba implementation
* \defgroup Pcba Package Pcba
/// @file PCBA.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef PCBA_H_ #ifndef PCBA_H_
#define 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); extern ErrorStatus PCBA_setIO(T_PL_GPIO* A0, T_PL_GPIO* A1);
#endif /* PCBA_H_ */ #endif /* PCBA_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/Version.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Version implementation
* \defgroup Version Package Version
/// @file Version.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef INC_VERSION_H_ #ifndef INC_VERSION_H_
#define INC_VERSION_H_ #define INC_VERSION_H_
@@ -75,3 +76,5 @@ struct Version
extern struct Version* Version_getInstance(void); extern struct Version* Version_getInstance(void);
#endif /* INC_VERSION_H_ */ #endif /* INC_VERSION_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * GPIO implementation
* \defgroup GPIO Package GPIO
/// @file gpio.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef INC_GPIO_H_ #ifndef INC_GPIO_H_
#define 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); extern ErrorStatus GPIO_getValue(struct Gpio* self, bool* value);
#endif /* INC_GPIO_H_ */ #endif /* INC_GPIO_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/internalADC.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * InternalADC implementation
* \defgroup InternalADC Package InternalADC
/// @file adc.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef INC_ADC_H_ #ifndef INC_ADC_H_
#define 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); extern ErrorStatus ADCChannel_read(const struct AdcChannel* self, uint16_t* value);
#endif /* INC_ADC_H_ */ #endif /* INC_ADC_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/keypadMatrix.h
View File

@@ -17,11 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Keypad implementation
* \defgroup Keypad Package Keypad
/// @file keypadMatrix.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef KEYPAD_INC_KEYPADMATRIX_H_ #ifndef KEYPAD_INC_KEYPADMATRIX_H_
@@ -134,3 +135,5 @@ extern void Keypad_destruct (const struct Keypad* self);
#endif /* KEYPAD_INC_KEYPADMATRIX_H_ */ #endif /* KEYPAD_INC_KEYPADMATRIX_H_ */
/** @} */

15
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/platform.h
View File

@@ -17,13 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {HAL} {group_description} /**
/// This file defines the properties for the Olimex STM32 H107 dev-kit * Platform implementation
/// platform. * \defgroup PlatformGroup Package Platform
/// * \ingroup Platform
* @{
/// @file olx_stm32_h107.h */
/// @ingroup {HAL}
#ifndef PLATFORM_INC_PLATFORM_H_ #ifndef PLATFORM_INC_PLATFORM_H_
@@ -138,3 +137,5 @@ extern ErrorStatus initPlatform(void);
extern ErrorStatus destructPlatform(void); extern ErrorStatus destructPlatform(void);
#endif /* PLATFORM_INC_PLATFORM_H_ */ #endif /* PLATFORM_INC_PLATFORM_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Rtc implementation
* \defgroup Rtc Package Rtc
/// @file rtc.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef INC_RTC_H_ #ifndef INC_RTC_H_
#define 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_ */ #endif /* INC_RTC_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spi.h
View File

@@ -17,11 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Spi implementation
* \defgroup Spi Package Spi
/// @file spi.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef MISC_INC_SPI_H_ #ifndef MISC_INC_SPI_H_
@@ -150,3 +151,5 @@ extern ErrorStatus SPI_getDefaultParameters(struct SpiParameters* parameters);
#endif /* MISC_INC_SPI_H_ */ #endif /* MISC_INC_SPI_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/spiDevice.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * SpiDevice implementation
* \defgroup SpiDevice Package SpiDevice
/// @file spiDevice.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef PLATFORM_INC_SPIDEVICE_H_ #ifndef PLATFORM_INC_SPIDEVICE_H_
#define 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); extern ErrorStatus SpiDevice_write (const struct SpiDevice* self, const char* buffer, int length);
#endif /* PLATFORM_INC_SPIDEVICE_H_ */ #endif /* PLATFORM_INC_SPIDEVICE_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/uart.h
View File

@@ -17,11 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * UART implementation
* \defgroup UART Package UART
/// @file uart.h * \ingroup Platform
/// @ingroup {group_name} * @{
*/
#ifndef MISC_INC_UART_H_ #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_ */ #endif /* MISC_INC_UART_H_ */
/** @} */