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@418 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-11 14:20:29 +00:00
parent 1bbfa1c7f3
commit 33bbbf4827
15 changed files with 122 additions and 66 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/HAL/inc/DisplayDevice.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * DisplayDevice implementation
* \defgroup DisplayDevice Package DisplayDevice
/// @file DisplayDevice.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_DISPLAYDEVICE_H_ #ifndef INC_DISPLAYDEVICE_H_
#define INC_DISPLAYDEVICE_H_ #define INC_DISPLAYDEVICE_H_
@@ -379,3 +380,5 @@ extern ErrorStatus DisplayDevice_invert(const struct DisplayDevice* self);
extern ErrorStatus DisplayDevice_setBlinkingCursorState(const struct DisplayDevice* self, DisplayDevice_functionalState state); extern ErrorStatus DisplayDevice_setBlinkingCursorState(const struct DisplayDevice* self, DisplayDevice_functionalState state);
#endif /* INC_DISPLAYDEVICE_H_ */ #endif /* INC_DISPLAYDEVICE_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * HighVoltageDetection implementation
* \defgroup HighVoltageDetection Package HighVoltageDetection
/// @file HighVoltageDetection.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_HIGHVOLTAGEDETECTION_H_ #ifndef INC_HIGHVOLTAGEDETECTION_H_
#define INC_HIGHVOLTAGEDETECTION_H_ #define INC_HIGHVOLTAGEDETECTION_H_
@@ -97,3 +98,5 @@ extern void HighVoltageDetection_destruct(void);
extern bool HighVoltageDetection_isVoltagePresent(void); extern bool HighVoltageDetection_isVoltagePresent(void);
#endif /* INC_HIGHVOLTAGEDETECTION_H_ */ #endif /* INC_HIGHVOLTAGEDETECTION_H_ */
/** @} */

14
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h
View File

@@ -17,12 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * IODevice implementation
* \defgroup IODevice Package IODevice
/// @file IODevice.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef MISC_INC_IODEVICE_H_ #ifndef MISC_INC_IODEVICE_H_
#define MISC_INC_IODEVICE_H_ #define MISC_INC_IODEVICE_H_
@@ -117,3 +117,5 @@ extern ErrorStatus IODevice_read(const struct IODevice* self, char* buffer, size
#endif /* MISC_INC_IODEVICE_H_ */ #endif /* MISC_INC_IODEVICE_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Interlock implementation
* \defgroup Interlock Package Interlock
/// @file Interlock.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_INTERLOCK_H_ #ifndef INC_INTERLOCK_H_
#define INC_INTERLOCK_H_ #define INC_INTERLOCK_H_
@@ -144,3 +145,5 @@ extern bool Interlock_isClosed(struct Interlock* self);
extern void Interlock_setEXTI(struct Interlock* self, FunctionalState command); extern void Interlock_setEXTI(struct Interlock* self, FunctionalState command);
#endif /* INC_INTERLOCK_H_ */ #endif /* INC_INTERLOCK_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * KeyboardDevice implementation
* \defgroup KeyboardDevice Package KeyboardDevice
/// @file KeyboardDevice.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_KEYBOARDDEVICE_H_ #ifndef INC_KEYBOARDDEVICE_H_
#define INC_KEYBOARDDEVICE_H_ #define INC_KEYBOARDDEVICE_H_
@@ -75,3 +76,5 @@ extern ErrorStatus KeyboardDevice_construct (struct KeyboardDevice* self, struct
extern ErrorStatus KeyboardDevice_read(const struct KeyboardDevice* self, char* buffer, Keypad_KeyState* keyState); extern ErrorStatus KeyboardDevice_read(const struct KeyboardDevice* self, char* buffer, Keypad_KeyState* keyState);
#endif /* INC_KEYBOARDDEVICE_H_ */ #endif /* INC_KEYBOARDDEVICE_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Leds implementation
* \defgroup Leds Package Leds
/// @file Leds.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_LEDS_H_ #ifndef INC_LEDS_H_
#define INC_LEDS_H_ #define INC_LEDS_H_
@@ -123,3 +124,5 @@ extern bool Led_getStatus(Led led);
#endif /* INC_LEDS_H_ */ #endif /* INC_LEDS_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Logger implementation
* \defgroup Logger Package Logger
/// @file Logger.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef _LOGGER_H_ #ifndef _LOGGER_H_
#define _LOGGER_H_ #define _LOGGER_H_
@@ -141,3 +142,5 @@ void Logger_logISR(struct Logger* self, const char* fileName, const char* functi
void Logger_log(struct Logger* self, const char* fileName, const char* functionName, int lineNumber, LogType logType, const char* format, ...) __attribute__((format(printf, 6, 7))); void Logger_log(struct Logger* self, const char* fileName, const char* functionName, int lineNumber, LogType logType, const char* format, ...) __attribute__((format(printf, 6, 7)));
#endif #endif
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MAX5715 implementation
* \defgroup MAX5715 Package MAX5715
/// @file MAX5715.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_MAX5715_H_ #ifndef INC_MAX5715_H_
#define INC_MAX5715_H_ #define INC_MAX5715_H_
@@ -241,3 +242,5 @@ extern ErrorStatus MAX5715Channel_construct(struct MAX5715_DAC* self, struct MAX
extern ErrorStatus MAX5715Channel_setValue(struct MAX5715_DAC* self, uint16_t value); extern ErrorStatus MAX5715Channel_setValue(struct MAX5715_DAC* self, uint16_t value);
#endif /* INC_MAX5715_H_ */ #endif /* INC_MAX5715_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MemoryDevice implementation
* \defgroup MemoryDevice Package MemoryDevice
/// @file MemoryDevice.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_MEMORYDEVICE_H_ #ifndef INC_MEMORYDEVICE_H_
#define INC_MEMORYDEVICE_H_ #define INC_MEMORYDEVICE_H_
@@ -145,3 +146,5 @@ extern ErrorStatus MemoryDevice_read(const struct MemoryDevice* self, uint32_t*
extern ErrorStatus MemoryDevice_erasePage(struct MemoryDevice* self, unsigned int page); extern ErrorStatus MemoryDevice_erasePage(struct MemoryDevice* self, unsigned int page);
#endif /* INC_MEMORYDEVICE_H_ */ #endif /* INC_MEMORYDEVICE_H_ */
/** @} */

9
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h
View File

@@ -16,6 +16,13 @@
* ----------------------------------------------------------------------------- * -----------------------------------------------------------------------------
*/ */
/**
* Observable implementation
* \defgroup Observable Package Observable
* \ingroup HAL
* @{
*/
#ifndef _OBSERVABLE_H_ #ifndef _OBSERVABLE_H_
#define _OBSERVABLE_H_ #define _OBSERVABLE_H_
@@ -125,3 +132,5 @@ void Observable_deleteObservers(struct Observable* self);
int Observable_nrOfObservers(struct Observable* self); int Observable_nrOfObservers(struct Observable* self);
#endif #endif
/** @} */

9
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observer.h
View File

@@ -16,6 +16,13 @@
* ----------------------------------------------------------------------------- * -----------------------------------------------------------------------------
*/ */
/**
* Observer implementation
* \defgroup Observer Package Observer
* \ingroup HAL
* @{
*/
#ifndef _OBSERVER_H_ #ifndef _OBSERVER_H_
#define _OBSERVER_H_ #define _OBSERVER_H_
@@ -37,3 +44,5 @@
typedef ErrorStatus (*Observer)(const void* const data); typedef ErrorStatus (*Observer)(const void* const data);
#endif #endif
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * PID implementation
* \defgroup PID Package PID
/// @file PID.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_PID_H_ #ifndef INC_PID_H_
#define INC_PID_H_ #define INC_PID_H_
@@ -125,3 +126,5 @@ extern void PID_reset(struct Pid* self);
extern int PID_calculate(struct Pid* self, int error); extern int PID_calculate(struct Pid* self, int error);
#endif /* INC_PID_H_ */ #endif /* INC_PID_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * TeslaGunSafety implementation
* \defgroup TeslaGunSafety Package TeslaGunSafety
/// @file TeslaGunSafety.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_TESLAGUNSAFETY_H_ #ifndef INC_TESLAGUNSAFETY_H_
#define INC_TESLAGUNSAFETY_H_ #define INC_TESLAGUNSAFETY_H_
@@ -122,3 +123,5 @@ extern ErrorStatus TeslaGunSafety_block(void);
*/ */
extern struct Gpio* TeslaGunSafety_getGpio(void); extern struct Gpio* TeslaGunSafety_getGpio(void);
#endif /* INC_TESLASAFETY_H_ */ #endif /* INC_TESLASAFETY_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * nhd0420 implementation
* \defgroup nhd0420 Package nhd0420
/// @file nhd0420.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef DISPLAY_INC_NHD0420_H_ #ifndef DISPLAY_INC_NHD0420_H_
@@ -289,3 +290,5 @@ extern ErrorStatus NHD0420_sendCommand(const struct NHD0420* self, char command)
extern ErrorStatus NHD0420_sendData(const struct NHD0420* self, const char* buffer, unsigned int length); extern ErrorStatus NHD0420_sendData(const struct NHD0420* self, const char* buffer, unsigned int length);
#endif /* DISPLAY_INC_NHD0420_H_ */ #endif /* DISPLAY_INC_NHD0420_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Storm700 implementation
* \defgroup Storm700 Package Storm700
/// @file storm700.h * \ingroup HAL
/// @ingroup {group_name} * @{
*/
#ifndef INC_STORM700_H_ #ifndef INC_STORM700_H_
#define INC_STORM700_H_ #define INC_STORM700_H_
@@ -108,3 +109,5 @@ extern void Storm700_destruct(struct Storm700* self);
extern ErrorStatus Storm700_readKey(const struct Storm700* self, char* key, Keypad_KeyState* keyState); extern ErrorStatus Storm700_readKey(const struct Storm700* self, char* key, Keypad_KeyState* keyState);
#endif /* INC_STORM700_H_ */ #endif /* INC_STORM700_H_ */
/** @} */