diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h index 4142186..749a79b 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file ADCDevice.h -/// @ingroup {group_name} +/** + * ADCDevice implementation + * \defgroup ADCDevice Package ADCDevice + * \ingroup HAL + * @{ + */ #ifndef INC_ADCDEVICE_H_ #define INC_ADCDEVICE_H_ @@ -100,3 +101,5 @@ extern void ADCDevice_destruct(struct ADCDevice* self); extern uint32_t ADCDevice_read(const struct ADCDevice* self); #endif /* INC_ADCDEVICE_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h index ef22200..cc6e049 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file Buzzer.h -/// @ingroup {group_name} +/** + * Buzzer implementation + * \defgroup Buzzer Package Buzzer + * \ingroup HAL + * @{ + */ #ifndef INC_BUZZER_H_ #define INC_BUZZER_H_ @@ -165,3 +166,5 @@ extern void Buzzer_singleTone(struct Buzzer* self, unsigned int pulseWidth); #endif /* INC_BUZZER_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h index 50e201a..b74a348 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h @@ -17,11 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file CachedStorage.h -/// @ingroup {group_name} +/** + * CachedStorage implementation + * \defgroup CachedStorage Package CachedStorage + * \ingroup HAL + * @{ + */ #ifndef _CACHEDEEPROM_H_ #define _CACHEDEEPROM_H_ @@ -197,3 +198,5 @@ const void* CachedStorage_readBlob(struct CachedStorage* self, int offset); void CachedStorage_commit(struct CachedStorage* self); #endif + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CoverSolenoid.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CoverSolenoid.h index 3924bde..7cbbdde 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CoverSolenoid.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CoverSolenoid.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file CoverSolenoid.h -/// @ingroup {group_name} +/** + * CoverSolenoid implementation + * \defgroup CoverSolenoid Package CoverSolenoid + * \ingroup HAL + * @{ + */ #ifndef SOLENOID_H_ #define SOLENOID_H_ @@ -115,3 +116,5 @@ extern ErrorStatus CoverSolenoid_lock(void); extern struct Gpio* CoverSolenoid_getGpio(void); #endif /* SOLENOID_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h index 0052b79..b2d765a 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DACDevice.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file DACDevice.h -/// @ingroup {group_name} +/** + * DACDevice implementation + * \defgroup DACDevice Package DACDevice + * \ingroup HAL + * @{ + */ #ifndef INC_DACDEVICE_H_ #define INC_DACDEVICE_H_ @@ -127,3 +128,5 @@ extern ErrorStatus DACDevice_write(const struct DACDevice* self, uint32_t voltag extern uint32_t DACDevice_getCurrentValue(const struct DACDevice* self); #endif /* INC_DACDEVICE_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/crc32.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/crc32.h index 927e973..5961631 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/crc32.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/crc32.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file crc32.h -/// @ingroup {group_name} +/** + * CRC32 implementation + * \defgroup CRC32 Package CRC32 + * \ingroup HAL + * @{ + */ #ifndef INC_CRC32_H_ #define INC_CRC32_H_ @@ -66,3 +67,5 @@ */ extern uint32_t crc32_calculate(uint32_t crc, const void* buffer, size_t size); #endif /* INC_CRC32_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.cfg b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.cfg index 64b676c..eb8ef03 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.cfg +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.cfg @@ -754,9 +754,10 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = \ -"HAL/inc" \ -"Platform/inc" \ -"hsb-mrts/inc" +doxygen.h \ +HAL/inc \ +Platform/inc \ +hsb-mrts/inc # This tag can be used to specify the character encoding of the source files diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.h new file mode 100644 index 0000000..68cdb83 --- /dev/null +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/doxygen.h @@ -0,0 +1,17 @@ +// Just some definitions for Doxygen. Does not to be included in any file + +/** +\defgroup HAL Hardware abstraction layer +Hardware abstraction layer +\defgroup hsb-mrts Application layer +Application layer +\defgroup Platform Platform layer +Platform layer + +@mainpage HSB design document +This document describes most of the classes used in the HSB software. Although this +software is written in C, an object-oriented approach is used where classed are coded as +structs. This also makes it possible to let doxygen generate class diagrams. +
+The "Modules" menu above is the easiest way to start browsing through all classes. +*/