More doxygen documentation

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@416 05563f52-14a8-4384-a975-3d1654cca0fa

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
+ * ADCDevice implementation
-
+ * \defgroup ADCDevice Package ADCDevice
-/// @file ADCDevice.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #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_ */
+
+/** @} */

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
+ * Buzzer implementation
-
+ * \defgroup Buzzer Package Buzzer
-/// @file Buzzer.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #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_ */
+
+/** @} */

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
+ * CachedStorage implementation
-
+ * \defgroup CachedStorage Package CachedStorage
-/// @file CachedStorage.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #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
+
+/** @} */

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
+ * CoverSolenoid implementation
-
+ * \defgroup CoverSolenoid Package CoverSolenoid
-/// @file CoverSolenoid.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef SOLENOID_H_
 #define SOLENOID_H_
@@ -115,3 +116,5 @@ extern ErrorStatus CoverSolenoid_lock(void);
 extern struct Gpio* CoverSolenoid_getGpio(void);
 
 #endif /* SOLENOID_H_ */
+
+/** @} */

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
+ * DACDevice implementation
-
+ * \defgroup DACDevice Package DACDevice
-/// @file DACDevice.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #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_ */
+
+/** @} */

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
+ * CRC32 implementation
-
+ * \defgroup CRC32 Package CRC32
-/// @file crc32.h
+ * \ingroup HAL
-/// @ingroup {group_name}
+ * @{
+ */
 
 #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_ */
+
+/** @} */

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" \
+doxygen.h \
-"Platform/inc" \
+HAL/inc \
-"hsb-mrts/inc" 
+Platform/inc \
+hsb-mrts/inc 
 
 
 # This tag can be used to specify the character encoding of the source files

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.
+<br/>
+The "Modules" menu above is the easiest way to start browsing through all classes.
+*/