From 33bbbf4827599f37262023aaab762c0212210810 Mon Sep 17 00:00:00 2001
From: dvl <dvl@05563f52-14a8-4384-a975-3d1654cca0fa>
Date: Thu, 11 Jan 2018 14:20:29 +0000
Subject: [PATCH] More doxygen documentation

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@418 05563f52-14a8-4384-a975-3d1654cca0fa
---
 .../0 - Code/HAL/inc/DisplayDevice.h               | 13 ++++++++-----
 .../0 - Code/HAL/inc/HighVoltageDetection.h        | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/IODevice.h | 14 ++++++++------
 .../0 - Code/HAL/inc/Interlock.h                   | 13 ++++++++-----
 .../0 - Code/HAL/inc/KeyboardDevice.h              | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/Leds.h     | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/Logger.h   | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/MAX5715.h  | 13 ++++++++-----
 .../0 - Code/HAL/inc/MemoryDevice.h                | 13 ++++++++-----
 .../0 - Code/HAL/inc/Observable.h                  |  9 +++++++++
 .../3 - Implementation/0 - Code/HAL/inc/Observer.h |  9 +++++++++
 .../3 - Implementation/0 - Code/HAL/inc/PID.h      | 13 ++++++++-----
 .../0 - Code/HAL/inc/TeslaGunSafety.h              | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/nhd0420.h  | 13 ++++++++-----
 .../3 - Implementation/0 - Code/HAL/inc/storm700.h | 13 ++++++++-----
 15 files changed, 122 insertions(+), 66 deletions(-)

diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h
index 9106325..5df0afa 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/DisplayDevice.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file DisplayDevice.h
-/// @ingroup {group_name}
+/**
+ * DisplayDevice implementation
+ * \defgroup DisplayDevice Package DisplayDevice
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_DISPLAYDEVICE_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/HighVoltageDetection.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/HighVoltageDetection.h
index 4637ec7..d422e2e 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/HighVoltageDetection.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/HighVoltageDetection.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file HighVoltageDetection.h
-/// @ingroup {group_name}
+/**
+ * HighVoltageDetection implementation
+ * \defgroup HighVoltageDetection Package HighVoltageDetection
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef INC_HIGHVOLTAGEDETECTION_H_
 #define INC_HIGHVOLTAGEDETECTION_H_
@@ -97,3 +98,5 @@ extern void HighVoltageDetection_destruct(void);
 extern bool HighVoltageDetection_isVoltagePresent(void);
 
 #endif /* INC_HIGHVOLTAGEDETECTION_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h
index 48dcc07..f301bdb 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/IODevice.h	
@@ -17,12 +17,12 @@
 //  (c) 2017 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file IODevice.h
-/// @ingroup {group_name}
-
+/**
+ * IODevice implementation
+ * \defgroup IODevice Package IODevice
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h
index 6f573f5..ce31c19 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Interlock.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file Interlock.h
-/// @ingroup {group_name}
+/**
+ * Interlock implementation
+ * \defgroup Interlock Package Interlock
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_INTERLOCK_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h
index 253f344..2890028 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/KeyboardDevice.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file KeyboardDevice.h
-/// @ingroup {group_name}
+/**
+ * KeyboardDevice implementation
+ * \defgroup KeyboardDevice Package KeyboardDevice
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_KEYBOARDDEVICE_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Leds.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Leds.h
index 282c704..68a4a04 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Leds.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Leds.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file Leds.h
-/// @ingroup {group_name}
+/**
+ * Leds implementation
+ * \defgroup Leds Package Leds
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef INC_LEDS_H_
 #define INC_LEDS_H_
@@ -123,3 +124,5 @@ extern bool Led_getStatus(Led led);
 
 
 #endif /* INC_LEDS_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h
index bad93f6..a344cec 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Logger.h	
@@ -17,11 +17,12 @@
 //  (c) 2017 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file Logger.h
-/// @ingroup {group_name}
+/**
+ * Logger implementation
+ * \defgroup Logger Package Logger
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef _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)));
 
 #endif
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h
index c2c9402..b595787 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MAX5715.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file MAX5715.h
-/// @ingroup {group_name}
+/**
+ * MAX5715 implementation
+ * \defgroup MAX5715 Package MAX5715
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_MAX5715_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h
index b748d7a..62703ce 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/MemoryDevice.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file MemoryDevice.h
-/// @ingroup {group_name}
+/**
+ * MemoryDevice implementation
+ * \defgroup MemoryDevice Package MemoryDevice
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_MEMORYDEVICE_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h
index 22a60ca..a98f6f4 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h	
@@ -16,6 +16,13 @@
  * -----------------------------------------------------------------------------
  */
 
+/**
+ * Observable implementation
+ * \defgroup Observable Package Observable
+ * \ingroup HAL
+ * @{
+ */
+
 #ifndef _OBSERVABLE_H_
 #define _OBSERVABLE_H_
 
@@ -125,3 +132,5 @@ void Observable_deleteObservers(struct Observable* self);
 int Observable_nrOfObservers(struct Observable* self);
 
 #endif
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observer.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observer.h
index e33af83..80a79bc 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observer.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observer.h	
@@ -16,6 +16,13 @@
  * -----------------------------------------------------------------------------
  */
 
+/**
+ * Observer implementation
+ * \defgroup Observer Package Observer
+ * \ingroup HAL
+ * @{
+ */
+
 #ifndef _OBSERVER_H_
 #define _OBSERVER_H_
 
@@ -37,3 +44,5 @@
 typedef ErrorStatus (*Observer)(const void* const data);
 
 #endif
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h
index fe3f22f..dd4ff8d 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/PID.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file PID.h
-/// @ingroup {group_name}
+/**
+ * PID implementation
+ * \defgroup PID Package PID
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_PID_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/TeslaGunSafety.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/TeslaGunSafety.h
index 33ad897..d8ba044 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/TeslaGunSafety.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/TeslaGunSafety.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file TeslaGunSafety.h
-/// @ingroup {group_name}
+/**
+ * TeslaGunSafety implementation
+ * \defgroup TeslaGunSafety Package TeslaGunSafety
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef INC_TESLAGUNSAFETY_H_
 #define INC_TESLAGUNSAFETY_H_
@@ -122,3 +123,5 @@ extern ErrorStatus TeslaGunSafety_block(void);
  */
 extern struct Gpio* TeslaGunSafety_getGpio(void);
 #endif /* INC_TESLASAFETY_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h
index c1b18cb..e17d17c 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/nhd0420.h	
@@ -17,11 +17,12 @@
 //  (c) 2017 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file nhd0420.h
-/// @ingroup {group_name}
+/**
+ * nhd0420 implementation
+ * \defgroup nhd0420 Package nhd0420
+ * \ingroup HAL
+ * @{
+ */
 
 
 #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);
 
 #endif /* DISPLAY_INC_NHD0420_H_ */
+
+/** @} */
diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h
index 03ba18c..84d1f5d 100644
--- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h	
+++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/storm700.h	
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
-/// Description
-
-/// @file storm700.h
-/// @ingroup {group_name}
+/**
+ * Storm700 implementation
+ * \defgroup Storm700 Package Storm700
+ * \ingroup HAL
+ * @{
+ */
 
 #ifndef 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);
 
 #endif /* INC_STORM700_H_ */
+
+/** @} */