From e3a3273e81e129a663495443f26779f4176686cd Mon Sep 17 00:00:00 2001 From: dvl Date: Thu, 11 Jan 2018 15:38:56 +0000 Subject: [PATCH] More doxygen documentation git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@421 05563f52-14a8-4384-a975-3d1654cca0fa --- .../0 - Code/hsb-mrts/inc/ADConverter.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/ADConverters.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/DAConverter.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/DAConverters.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/DeviceParameters.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/Display.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/DisplayContent.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/Displays.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/Error.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/FreeRTOSFixes.h | 14 ++++++++------ .../0 - Code/hsb-mrts/inc/MenuCore.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/MenuElements.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/MenuStates.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/MenuText.h | 12 +++++++----- .../0 - Code/hsb-mrts/inc/PIDParameters.h | 13 ++++++++----- .../3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/PowerLossDetector.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/hsb-mrts.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/hwValidationMenu.h | 13 ++++++++----- .../0 - Code/hsb-mrts/inc/repairMenu.h | 13 ++++++++----- 20 files changed, 159 insertions(+), 101 deletions(-) diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverter.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverter.h index e2c3355..440fa14 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverter.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverter.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file ADConverter.h -/// @ingroup {group_name} +/** + * ADConverter implementation + * \defgroup ADConverter Package ADConverter + * \ingroup hsb-mrts + * @{ + */ #ifndef ADCONVERTER_H_ #define ADCONVERTER_H_ @@ -103,3 +104,5 @@ extern int ADConverter_getInputVoltage(const struct ADConverter* self); extern unsigned int ADConverter_getInputConverterValue(const struct ADConverter* self); #endif /* ADCONVERTER_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverters.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverters.h index 0863bf2..1cdbad8 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverters.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverters.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file ADConverters.h -/// @ingroup {group_name} +/** + * ADConverters implementation + * \defgroup ADConverters Package ADConverters + * \ingroup hsb-mrts + * @{ + */ #ifndef ADCONVERTERS_H_ #define ADCONVERTERS_H_ @@ -78,3 +79,5 @@ extern ErrorStatus ADConverters_construct(void); extern void ADConverters_destruct(void); #endif /* ADCONVERTERS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverter.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverter.h index 07351fe..40a95cd 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverter.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverter.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file DAConverter.h -/// @ingroup {group_name} +/** + * DAConverter implementation + * \defgroup DAConverter Package DAConverter + * \ingroup hsb-mrts + * @{ + */ #ifndef DACONVERTER_H_ #define DACONVERTER_H_ @@ -117,3 +118,5 @@ extern uint32_t DAConverter_getCurrentValue(const struct DAConverter* self); #endif /* DACONVERTER_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverters.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverters.h index eb1a3ef..7dc93a4 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverters.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverters.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file DAConverters.h -/// @ingroup {group_name} +/** + * DAConverters implementation + * \defgroup DAConverters Package DAConverters + * \ingroup hsb-mrts + * @{ + */ #ifndef DACONVERTERS_H_ #define DACONVERTERS_H_ @@ -81,3 +82,5 @@ extern void DAConverters_destruct(void); #endif /* DACONVERTERS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DeviceParameters.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DeviceParameters.h index 8534bf8..3af735c 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DeviceParameters.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DeviceParameters.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file DeviceParameters.h -/// @ingroup {group_name} +/** + * DeviceParameters implementation + * \defgroup DeviceParameters Package DeviceParameters + * \ingroup hsb-mrts + * @{ + */ #ifndef DEVICEPARAMETERS_H_ #define DEVICEPARAMETERS_H_ @@ -127,3 +128,5 @@ ErrorStatus DeviceParameters_writePIDParameters(struct PIDParameters* parameters ErrorStatus DeviceParameters_writePIN(struct PIN* pin); #endif /* DEVICEPARAMETERS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Display.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Display.h index 885c504..e3436b0 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Display.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Display.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file Display.h -/// @ingroup {group_name} +/** + * Display implementation + * \defgroup Display Package Display + * \ingroup hsb-mrts + * @{ + */ #ifndef DISPLAY_H_ #define DISPLAY_H_ @@ -297,3 +298,5 @@ extern void Display_feedRefreshCounter(struct Display* self); extern void Display_feedRefreshCounterFromISR(struct Display* self); #endif /* DISPLAY_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DisplayContent.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DisplayContent.h index 2400481..23a6741 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DisplayContent.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DisplayContent.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file DisplayContent.h -/// @ingroup {group_name} +/** + * DisplayContent implementation + * \defgroup DisplayContent Package DisplayContent + * \ingroup hsb-mrts + * @{ + */ #ifndef DISPLAYCONTENT_H_ #define DISPLAYCONTENT_H_ @@ -176,3 +177,5 @@ extern void DisplayContent_refresh(struct DisplayContent* self); extern void DisplayContent_clear(struct DisplayContent* self); #endif /* DISPLAYCONTENT_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Displays.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Displays.h index e3e621b..3143f3e 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Displays.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Displays.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file Displays.h -/// @ingroup {group_name} +/** + * Displays implementation + * \defgroup Displays Package Displays + * \ingroup hsb-mrts + * @{ + */ #ifndef DISPLAYS_H_ #define DISPLAYS_H_ @@ -74,3 +75,5 @@ extern ErrorStatus Displays_construct(void); */ extern void Displays_destruct(void); #endif /* DISPLAYS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h index 8dbdfd4..02c5f74 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file Error.h -/// @ingroup {group_name} +/** + * Error implementation + * \defgroup Error Package Error + * \ingroup hsb-mrts + * @{ + */ #ifndef ERROR_H_ #define ERROR_H_ @@ -124,3 +125,5 @@ extern void Error_postErrorFromISR(T_ErrorCode errorCode); #endif /* ERROR_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 3b95cf6..36095c7 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 @@ -17,12 +17,12 @@ // (c) 2017 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file freeRTOSFixes.h -/// @ingroup {group_name} - +/** + * freeRTOSFixes implementation + * \defgroup freeRTOSFixes Package freeRTOSFixes + * \ingroup hsb-mrts + * @{ + */ #ifndef FREERTOSFIXES_H_ #define FREERTOSFIXES_H_ @@ -55,3 +55,5 @@ void OS_logTaskInfo(xTaskHandle taskHandle); #endif /* FREERTOSFIXES_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuCore.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuCore.h index 865f8d8..4c9bc53 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuCore.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuCore.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file MenuCore.h -/// @ingroup {group_name} +/** + * MenuCore implementation + * \defgroup MenuCore Package MenuCore + * \ingroup hsb-mrts + * @{ + */ #ifndef MENUCORE_H_ #define MENUCORE_H_ @@ -186,3 +187,5 @@ extern void MenuCore_changeState(struct MenuCore* self, T_MenuState newState); #endif /* MENUCORE_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuElements.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuElements.h index 5719a45..936ec0a 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuElements.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuElements.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file MenuElements.h -/// @ingroup {group_name} +/** + * MenuElements implementation + * \defgroup MenuElements Package MenuElements + * \ingroup hsb-mrts + * @{ + */ #ifndef MENUELEMENTS_H_ #define MENUELEMENTS_H_ @@ -82,3 +83,5 @@ extern ErrorStatus MenuElements_addKeyAction_DIGITREMOVE (struct MenuPage* self, extern ErrorStatus MenuElements_addKeyAction_DIGITINSERTCONFIRM (struct MenuPage* self, char key, Keypad_KeyState keyState, MenuCoreFunctionCall actionPointer); #endif /* MENUELEMENTS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuStates.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuStates.h index 24e2b63..6011edb 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuStates.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuStates.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file MenuStates.h -/// @ingroup {group_name} +/** + * MenuStates implementation + * \defgroup MenuStates Package MenuStates + * \ingroup hsb-mrts + * @{ + */ #ifndef MENUSTATES_H_ #define MENUSTATES_H_ @@ -120,3 +121,5 @@ typedef enum #endif /* MENUSTATES_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuText.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuText.h index adcc306..5ed2071 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuText.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuText.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file MenuText.h -/// @ingroup {group_name} +/** + * MenuText implementation + * \defgroup MenuText Package MenuText + * \ingroup hsb-mrts + * @{ + */ #ifndef MENUTEXT_H_ #define MENUTEXT_H_ @@ -716,3 +717,4 @@ static const char MenuText_CALIBRATION_SETPOINTMENU[MENUTEXT_NUMBER_OF_LANGUAGES #endif /* MENUTEXT_H_ */ +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIDParameters.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIDParameters.h index 9b11a67..5c0425f 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIDParameters.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIDParameters.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file PIDParameters.h -/// @ingroup {group_name} +/** + * PIDParameters implementation + * \defgroup PIDParameters Package PIDParameters + * \ingroup hsb-mrts + * @{ + */ #ifndef PIDPARAMETERS_H_ #define PIDPARAMETERS_H_ @@ -138,3 +139,5 @@ extern void PIDParameters_setiMin(struct PIDParameters* self, int iMin); */ extern void PIDParameters_setiMax(struct PIDParameters* self, int iMax); #endif /* PIDPARAMETERS_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h index 14ed3c1..c26b666 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file PIN.h -/// @ingroup {group_name} +/** + * PIN implementation + * \defgroup PIN Package PIN + * \ingroup hsb-mrts + * @{ + */ #ifndef PIN_H_ #define PIN_H_ @@ -121,3 +122,5 @@ extern void PIN_changePinFirstInsert(struct PIN* self, char* const firstPinInser extern ErrorStatus PIN_changePinSecondInsert(struct PIN* self, char* const secondPinInsert); #endif /* PIN_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PowerLossDetector.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PowerLossDetector.h index 6b1bdda..9a9a609 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PowerLossDetector.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PowerLossDetector.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file PowerLossDetector.h -/// @ingroup {group_name} +/** + * PowerLossDetector implementation + * \defgroup PowerLossDetector Package PowerLossDetector + * \ingroup hsb-mrts + * @{ + */ #ifndef POWERLOSSDETECTOR_H_ #define POWERLOSSDETECTOR_H_ @@ -116,3 +117,5 @@ extern void PowerLossDetector_clearBusyFlag(void); extern bool PowerLossDetection_isFlagSet(void); #endif /* POWERLOSSDETECTOR_H_ */ + +/** @} */ diff --git a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hsb-mrts.h b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hsb-mrts.h index 77fb91c..ca7c5d1 100644 --- a/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hsb-mrts.h +++ b/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/hsb-mrts.h @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file hsb-mrts.h -/// @ingroup {group_name} +/** + * hsb-mrts implementation + * \defgroup hsb-mrts Package hsb-mrts + * \ingroup hsb-mrts + * @{ + */ #ifndef HSB_MRTS_H_ #define HSB_MRTS_H_ @@ -132,3 +133,5 @@ extern ErrorStatus hsb_enableSafetyWithWarning(void); extern ErrorStatus hsb_disableSafety(void); extern bool hsb_safetyIsEnabled(void); #endif /* HSB_MRTS_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 46e7937..58356e7 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 @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file hwValidationMenu.h -/// @ingroup {group_name} +/** + * hwValidationMenu implementation + * \defgroup hwValidationMenu Package hwValidationMenu + * \ingroup hsb-mrts + * @{ + */ #ifndef INC_HWVALIDATIONMENU_H_ #define INC_HWVALIDATIONMENU_H_ @@ -117,3 +118,5 @@ extern ErrorStatus HwValidationMenu_construct(struct HwValidationMenu* self, str #endif /* INC_HWVALIDATIONMENU_H_ */ + +/** @} */ 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 b06d918..50a0485 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 @@ -17,11 +17,12 @@ // (c) 2015 Micro-Key bv // ----------------------------------------------------------------------------- -/// @defgroup {group_name} {group_description} -/// Description - -/// @file repairMenu.h -/// @ingroup {group_name} +/** + * repairMenu implementation + * \defgroup repairMenu Package repairMenu + * \ingroup hsb-mrts + * @{ + */ #ifndef INC_REPAIRMENU_H_ #define INC_REPAIRMENU_H_ @@ -178,3 +179,5 @@ extern void repairMenu_menuStateHandle(struct MenuCore* menuCore); extern void repairMenu_createMenuEntries(struct MenuCore* menuCore); #endif /* INC_REPAIRMENU_H_ */ + +/** @} */