Doxygen update

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

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/ADCDevice.h

@@ -23,7 +23,7 @@
 
 /**
  * ADCDevice implementation
- * \defgroup ADCDevice ADCDevice
+ * \defgroup ADCDevice Package ADCDevice
  * \ingroup HAL
  * @{
  */
@@ -45,7 +45,6 @@ struct ADCDevice;
 typedef uint32_t (*ADCReadFunction)(const struct ADCDevice* self);
 
 /**
- * \ingroup ADCDevice
  * \class ADCDevice
  * The ADCDevice struct that can be used as an object
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h

@@ -22,7 +22,7 @@
 
 /**
  * Buzzer implementation
- * \defgroup Buzzer Buzzer
+ * \defgroup Buzzer Package Buzzer
  * \ingroup HAL
  * @{
  */
@@ -62,7 +62,6 @@
 // -----------------------------------------------------------------------------
 
 /**
- * \ingroup Buzzer
  * \class Buzzer
  * The Buzzer struct that can be used as an object
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h

@@ -22,7 +22,7 @@
 
 /**
  * CachedStorage implementation
- * \defgroup CachedStorage CachedStorage
+ * \defgroup CachedStorage Package CachedStorage
  * \ingroup HAL
  * @{
  */
@@ -50,7 +50,6 @@
 // -----------------------------------------------------------------------------
 
 /**
- * \ingroup CachedStorage
  * \class CachedStorage
  * The CachedStorage struct that can be used as an object
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CoverSolenoid.h

@@ -22,7 +22,7 @@
 
 /**
  * CoverSolenoid implementation
- * \defgroup CoverSolenoid CoverSolenoid
+ * \defgroup CoverSolenoid Package CoverSolenoid
  * \ingroup HAL
  * @{
  */

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

@@ -51,9 +51,15 @@ typedef enum
    OUTPUT = !INPUT
 } GpioDirection;
 
+/**
+ * \class Gpio
+ * \extends IODevice
+ * The Gpio struct that can be used as an object
+ */
+
 struct Gpio
 {
-   struct IODevice device;
+   struct IODevice device; //!< \private
    T_PL_GPIO gpio;
    GpioDirection direction;
    bool status;

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationParameters.h

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-/// @file  CalibrationSetpoints.h
+/// @file  CalibrationParameters.h
 /// @brief File description
 // -----------------------------------------------------------------------------
 //  Micro-Key bv
@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * CalibrationParameters implementation
-
+ * \defgroup CalibrationParameters Package CalibrationParameters
-/// @file CalibrationSetpoints.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef CALIBRATIONPARAMETERS_H_
 #define CALIBRATIONPARAMETERS_H_
@@ -122,3 +123,5 @@ extern void CalibrationParameters_saveParameters(void);
 
 
 #endif /* CALIBRATIONPARAMETERS_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoint.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * CalibrationSetpoint implementation
-
+ * \defgroup CalibrationSetpoint Package CalibrationSetpoint
-/// @file CalibrationSetpoint.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef CALIBRATIONSETPOINT_H_
 #define CALIBRATIONSETPOINT_H_
@@ -83,3 +84,5 @@ extern void CalibrationSetpoint_setHighSetpoint(struct CalibrationSetpoint* self
 
 
 #endif /* CALIBRATIONSETPOINT_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoints.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * CalibrationSetpoints implementation
-
+ * \defgroup CalibrationSetpoints Package CalibrationSetpoints
-/// @file CalibrationSetpoints.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef CALIBRATIONSETPOINTS_H_
 #define CALIBRATIONSETPOINTS_H_
@@ -119,3 +120,5 @@ extern struct CalibrationSetpoint* CalibrationSetpoints_getActiveSetpointSet(str
 
 
 #endif /* CALIBRATIONSETPOINTS_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSConfig.h

@@ -17,12 +17,12 @@
 //  (c) 2017 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * FreeRTOSConfig implementation
-
+ * \defgroup FreeRTOSConfig Package FreeRTOSConfig
-/// @file FreeRTOSConfig.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
-
+ */
 
 #ifndef FREERTOSCONFIG_H_
 #define FREERTOSCONFIG_H_
@@ -133,3 +133,5 @@ extern unsigned long ulRunTimeStatsClock;
 #define portGET_RUN_TIME_COUNTER_VALUE() ulRunTimeStatsClock
 
 #endif /* FREERTOSCONFIG_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSFixes.h

@@ -18,8 +18,8 @@
 // -----------------------------------------------------------------------------
 
 /**
- * freeRTOSFixes implementation
+ * FreeRTOSFixes implementation
- * \defgroup freeRTOSFixes Package freeRTOSFixes
+ * \defgroup FreeRTOSFixes Package FreeRTOSFixes
  * \ingroup hsb-mrts
  * @{
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPreset.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairPreset implementation
-
+ * \defgroup RepairPreset Package RepairPreset
-/// @file repairPreset.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRPRESET_H_
 #define REPAIRPRESET_H_
@@ -127,3 +128,5 @@ extern void RepairPreset_setDurationValue(struct RepairPresetParameters* self, u
 extern void RepairPreset_setVoltageValue(struct RepairPresetParameters* self, int value);
 
 #endif /* REPAIRPRESET_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPresets.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairPresets implementation
-
+ * \defgroup RepairPresets Package RepairPresets
-/// @file RepairPresets.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRPRESETS_H_
 #define REPAIRPRESETS_H_
@@ -133,3 +134,5 @@ extern void RepairPresets_savePresets(void);
 
 
 #endif /* REPAIRPRESETS_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/SignalProfileGenerator.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * SignalProfileGenerator implementation
-
+ * \defgroup SignalProfileGenerator Package SignalProfileGenerator
-/// @file SignalProfileGenerator.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef INC_SIGNALPROFILEGENERATOR_H_
 #define INC_SIGNALPROFILEGENERATOR_H_
@@ -116,3 +117,5 @@ extern uint32_t SignalProfileGenerator_getRemainingTime(const struct SignalProfi
 
 extern uint32_t SignalProfileGenerator_getTotalRepairTime(const struct SignalProfileGenerator* self);
 #endif /* INC_SIGNALPROFILEGENERATOR_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Voltage.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * Voltage implementation
-
+ * \defgroup Voltage Package Voltage
-/// @file Voltage.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef VOLTAGE_H_
 #define VOLTAGE_H_
@@ -56,3 +57,5 @@ extern uint32_t Voltage_calculateDeviceValue(int value, uint32_t resolutionInBit
 
 
 #endif /* VOLTAGE_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Warning.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * Warning implementation
-
+ * \defgroup Warning Package Warning
-/// @file Warning.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef WARNING_H_
 #define WARNING_H_
@@ -111,3 +112,5 @@ extern void Warning_postWarning(T_WarningCode warningCode);
 extern void Warning_postWarningFromISR(T_WarningCode warningCode);
 
 #endif /* WARNING_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hwValidationMenu.h

@@ -18,8 +18,8 @@
 // -----------------------------------------------------------------------------
 
 /**
- * hwValidationMenu implementation
+ * HwValidationMenu implementation
- * \defgroup hwValidationMenu Package hwValidationMenu
+ * \defgroup HwValidationMenu Package HwValidationMenu
  * \ingroup hsb-mrts
  * @{
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenu.h

@@ -18,8 +18,8 @@
 // -----------------------------------------------------------------------------
 
 /**
- * repairMenu implementation
+ * RepairMenu implementation
- * \defgroup repairMenu Package repairMenu
+ * \defgroup RepairMenu Package RepairMenu
  * \ingroup hsb-mrts
  * @{
  */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenus.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairMenus implementation
-
+ * \defgroup RepairMenus Package RepairMenus
-/// @file repairMenus.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRMENUS_H_
 #define REPAIRMENUS_H_
@@ -80,3 +81,5 @@ extern  struct RepairMenu* repairMenus_getMainRepairMenu(void);
 
 
 #endif /* REPAIRMENUS_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcess.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairProcess implementation
-
+ * \defgroup RepairProcess Package RepairProcess
-/// @file repairProcess.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRPROCESS_H_
 #define REPAIRPROCESS_H_
@@ -235,3 +236,5 @@ extern void repairProcess_pauseProcess(struct RepairProcess* self);
 extern void repairProcess_continueProcess(struct RepairProcess* self);
 
 #endif /* REPAIRPROCESS_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcessRow.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairProcessRow implementation
-
+ * \defgroup RepairProcessRow Package RepairProcessRow
-/// @file repairProcessRow.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRPROCESSROW_H_
 #define REPAIRPROCESSROW_H_
@@ -105,3 +106,5 @@ extern ErrorStatus repairProcessRow_construct(struct RepairProcessRow* self, con
 extern void repairProcessRow_destruct(struct RepairProcessRow* self);
 
 #endif /* REPAIRPROCESSROW_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcesses.h

@@ -17,11 +17,12 @@
 //  (c) 2015 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * RepairProcesses implementation
-
+ * \defgroup RepairProcesses Package RepairProcesses
-/// @file repairProcesses.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
+ */
 
 #ifndef REPAIRPROCESSES_H_
 #define REPAIRPROCESSES_H_
@@ -67,3 +68,5 @@ extern void repairProcesses_mainRepairProcessRemoveObserver (const Observer obse
 extern struct RepairProcess* repairProcesses_getMainRepairProcess(void);
 
 #endif /* REPAIRPROCESSES_H_ */
+
+/** @} */

S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/stm32f10x_it.h

@@ -17,12 +17,12 @@
 //  (c) 2017 Micro-Key bv
 // -----------------------------------------------------------------------------
 
-/// @defgroup {group_name} {group_description}
+/**
-/// Description
+ * STM32f10x_it implementation
-
+ * \defgroup STM32f10x_it Package STM32f10x_it
-/// @file stm32f10x_it.h
+ * \ingroup hsb-mrts
-/// @ingroup {group_name}
+ * @{
-
+ */
 
 #ifndef STM32F10X_IT_H_
 #define STM32F10X_IT_H_
@@ -65,3 +65,5 @@ extern void IRQ_setKeypadEXTI(struct Keypad* self, FunctionalState command);
 #endif
 
 #endif /* STM32F10X_IT_H_ */
+
+/** @} */