From 41ebc0274176d44a6621f0b039b36444670a6eb2 Mon Sep 17 00:00:00 2001 From: dvl Date: Mon, 15 Jan 2018 09:09:09 +0000 Subject: [PATCH] Doxygen update git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@426 05563f52-14a8-4384-a975-3d1654cca0fa --- .../0 - Code/HAL/inc/ADCDevice.h | 3 +-- .../3 - Implementation/0 - Code/HAL/inc/Buzzer.h | 3 +-- .../0 - Code/HAL/inc/CachedStorage.h | 3 +-- .../0 - Code/HAL/inc/CoverSolenoid.h | 2 +- .../0 - Code/Platform/inc/gpio.h | 8 +++++++- .../0 - Code/hsb-mrts/inc/CalibrationParameters.h | 15 +++++++++------ .../0 - Code/hsb-mrts/inc/CalibrationSetpoint.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/CalibrationSetpoints.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/FreeRTOSConfig.h | 14 ++++++++------ .../0 - Code/hsb-mrts/inc/FreeRTOSFixes.h | 4 ++-- .../0 - Code/hsb-mrts/inc/RepairPreset.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/RepairPresets.h | 13 ++++++++----- .../hsb-mrts/inc/SignalProfileGenerator.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/Voltage.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/Warning.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/hwValidationMenu.h | 4 ++-- .../0 - Code/hsb-mrts/inc/repairMenu.h | 4 ++-- .../0 - Code/hsb-mrts/inc/repairMenus.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/repairProcess.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/repairProcessRow.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/repairProcesses.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/stm32f10x_it.h | 14 ++++++++------ 22 files changed, 130 insertions(+), 87 deletions(-) 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 f0331a7..0a561f8 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 @@ -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 */ 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 00624c1..355df5c 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 @@ -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 */ 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 66bbbdc..f45569e 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 @@ -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 */ 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 b4225ab..7d6581e 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 @@ -22,7 +22,7 @@ /** * CoverSolenoid implementation - * \defgroup CoverSolenoid CoverSolenoid + * \defgroup CoverSolenoid Package CoverSolenoid * \ingroup HAL * @{ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h index 5410bf1..f03f154 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/gpio.h +++ b/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; diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationParameters.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationParameters.h index 4b1aaed..949a313 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationParameters.h +++ b/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 - -/// @file CalibrationSetpoints.h -/// @ingroup {group_name} +/** + * CalibrationParameters implementation + * \defgroup CalibrationParameters Package CalibrationParameters + * \ingroup hsb-mrts + * @{ + */ #ifndef CALIBRATIONPARAMETERS_H_ #define CALIBRATIONPARAMETERS_H_ @@ -122,3 +123,5 @@ extern void CalibrationParameters_saveParameters(void); #endif /* CALIBRATIONPARAMETERS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoint.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoint.h index 12a6656..0f6eaa5 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoint.h +++ b/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 - -/// @file CalibrationSetpoint.h -/// @ingroup {group_name} +/** + * CalibrationSetpoint implementation + * \defgroup CalibrationSetpoint Package CalibrationSetpoint + * \ingroup hsb-mrts + * @{ + */ #ifndef CALIBRATIONSETPOINT_H_ #define CALIBRATIONSETPOINT_H_ @@ -83,3 +84,5 @@ extern void CalibrationSetpoint_setHighSetpoint(struct CalibrationSetpoint* self #endif /* CALIBRATIONSETPOINT_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoints.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoints.h index 3192df7..c9b942b 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/CalibrationSetpoints.h +++ b/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 - -/// @file CalibrationSetpoints.h -/// @ingroup {group_name} +/** + * CalibrationSetpoints implementation + * \defgroup CalibrationSetpoints Package CalibrationSetpoints + * \ingroup hsb-mrts + * @{ + */ #ifndef CALIBRATIONSETPOINTS_H_ #define CALIBRATIONSETPOINTS_H_ @@ -119,3 +120,5 @@ extern struct CalibrationSetpoint* CalibrationSetpoints_getActiveSetpointSet(str #endif /* CALIBRATIONSETPOINTS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSConfig.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSConfig.h index 857daa7..f26bb32 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSConfig.h +++ b/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 - -/// @file FreeRTOSConfig.h -/// @ingroup {group_name} - +/** + * FreeRTOSConfig implementation + * \defgroup FreeRTOSConfig Package FreeRTOSConfig + * \ingroup hsb-mrts + * @{ + */ #ifndef FREERTOSCONFIG_H_ #define FREERTOSCONFIG_H_ @@ -133,3 +133,5 @@ extern unsigned long ulRunTimeStatsClock; #define portGET_RUN_TIME_COUNTER_VALUE() ulRunTimeStatsClock #endif /* FREERTOSCONFIG_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSFixes.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSFixes.h index 36095c7..aac79be 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSFixes.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/FreeRTOSFixes.h @@ -18,8 +18,8 @@ // ----------------------------------------------------------------------------- /** - * freeRTOSFixes implementation - * \defgroup freeRTOSFixes Package freeRTOSFixes + * FreeRTOSFixes implementation + * \defgroup FreeRTOSFixes Package FreeRTOSFixes * \ingroup hsb-mrts * @{ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPreset.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPreset.h index e037bca..65ec778 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPreset.h +++ b/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 - -/// @file repairPreset.h -/// @ingroup {group_name} +/** + * RepairPreset implementation + * \defgroup RepairPreset Package RepairPreset + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPresets.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPresets.h index 52cea26..222dd58 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/RepairPresets.h +++ b/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 - -/// @file RepairPresets.h -/// @ingroup {group_name} +/** + * RepairPresets implementation + * \defgroup RepairPresets Package RepairPresets + * \ingroup hsb-mrts + * @{ + */ #ifndef REPAIRPRESETS_H_ #define REPAIRPRESETS_H_ @@ -133,3 +134,5 @@ extern void RepairPresets_savePresets(void); #endif /* REPAIRPRESETS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/SignalProfileGenerator.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/SignalProfileGenerator.h index 1ee7b2e..fb22238 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/SignalProfileGenerator.h +++ b/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 - -/// @file SignalProfileGenerator.h -/// @ingroup {group_name} +/** + * SignalProfileGenerator implementation + * \defgroup SignalProfileGenerator Package SignalProfileGenerator + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Voltage.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Voltage.h index 2a31c73..a9805c2 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Voltage.h +++ b/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 - -/// @file Voltage.h -/// @ingroup {group_name} +/** + * Voltage implementation + * \defgroup Voltage Package Voltage + * \ingroup hsb-mrts + * @{ + */ #ifndef VOLTAGE_H_ #define VOLTAGE_H_ @@ -56,3 +57,5 @@ extern uint32_t Voltage_calculateDeviceValue(int value, uint32_t resolutionInBit #endif /* VOLTAGE_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Warning.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Warning.h index 4273528..9edf43b 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Warning.h +++ b/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 - -/// @file Warning.h -/// @ingroup {group_name} +/** + * Warning implementation + * \defgroup Warning Package Warning + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hwValidationMenu.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hwValidationMenu.h index 58356e7..36894ae 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hwValidationMenu.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hwValidationMenu.h @@ -18,8 +18,8 @@ // ----------------------------------------------------------------------------- /** - * hwValidationMenu implementation - * \defgroup hwValidationMenu Package hwValidationMenu + * HwValidationMenu implementation + * \defgroup HwValidationMenu Package HwValidationMenu * \ingroup hsb-mrts * @{ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenu.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenu.h index 50a0485..a005648 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenu.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenu.h @@ -18,8 +18,8 @@ // ----------------------------------------------------------------------------- /** - * repairMenu implementation - * \defgroup repairMenu Package repairMenu + * RepairMenu implementation + * \defgroup RepairMenu Package RepairMenu * \ingroup hsb-mrts * @{ */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenus.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenus.h index 3e574e4..7d18e39 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairMenus.h +++ b/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 - -/// @file repairMenus.h -/// @ingroup {group_name} +/** + * RepairMenus implementation + * \defgroup RepairMenus Package RepairMenus + * \ingroup hsb-mrts + * @{ + */ #ifndef REPAIRMENUS_H_ #define REPAIRMENUS_H_ @@ -80,3 +81,5 @@ extern struct RepairMenu* repairMenus_getMainRepairMenu(void); #endif /* REPAIRMENUS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcess.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcess.h index 9cac3e9..b8f6623 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcess.h +++ b/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 - -/// @file repairProcess.h -/// @ingroup {group_name} +/** + * RepairProcess implementation + * \defgroup RepairProcess Package RepairProcess + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcessRow.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcessRow.h index e08f653..2f542aa 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcessRow.h +++ b/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 - -/// @file repairProcessRow.h -/// @ingroup {group_name} +/** + * RepairProcessRow implementation + * \defgroup RepairProcessRow Package RepairProcessRow + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcesses.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcesses.h index d0bdda1..09e0341 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/repairProcesses.h +++ b/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 - -/// @file repairProcesses.h -/// @ingroup {group_name} +/** + * RepairProcesses implementation + * \defgroup RepairProcesses Package RepairProcesses + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/stm32f10x_it.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/stm32f10x_it.h index ba65ab6..054e714 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/stm32f10x_it.h +++ b/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 - -/// @file stm32f10x_it.h -/// @ingroup {group_name} - +/** + * STM32f10x_it implementation + * \defgroup STM32f10x_it Package STM32f10x_it + * \ingroup hsb-mrts + * @{ + */ #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_ */ + +/** @} */