private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More doxygen documentation

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@421 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-11 15:38:56 +00:00
parent 90f6da3dbe
commit e3a3273e81
20 changed files with 159 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverter.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * ADConverter implementation
* \defgroup ADConverter Package ADConverter
/// @file ADConverter.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef ADCONVERTER_H_ #ifndef ADCONVERTER_H_
#define 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); extern unsigned int ADConverter_getInputConverterValue(const struct ADConverter* self);
#endif /* ADCONVERTER_H_ */ #endif /* ADCONVERTER_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/ADConverters.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * ADConverters implementation
* \defgroup ADConverters Package ADConverters
/// @file ADConverters.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef ADCONVERTERS_H_ #ifndef ADCONVERTERS_H_
#define ADCONVERTERS_H_ #define ADCONVERTERS_H_
@@ -78,3 +79,5 @@ extern ErrorStatus ADConverters_construct(void);
extern void ADConverters_destruct(void); extern void ADConverters_destruct(void);
#endif /* ADCONVERTERS_H_ */ #endif /* ADCONVERTERS_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverter.h
View File

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

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DAConverters.h
View File

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

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DeviceParameters.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * DeviceParameters implementation
* \defgroup DeviceParameters Package DeviceParameters
/// @file DeviceParameters.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef DEVICEPARAMETERS_H_ #ifndef DEVICEPARAMETERS_H_
#define DEVICEPARAMETERS_H_ #define DEVICEPARAMETERS_H_
@@ -127,3 +128,5 @@ ErrorStatus DeviceParameters_writePIDParameters(struct PIDParameters* parameters
ErrorStatus DeviceParameters_writePIN(struct PIN* pin); ErrorStatus DeviceParameters_writePIN(struct PIN* pin);
#endif /* DEVICEPARAMETERS_H_ */ #endif /* DEVICEPARAMETERS_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Display.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Display implementation
* \defgroup Display Package Display
/// @file Display.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef DISPLAY_H_ #ifndef DISPLAY_H_
#define DISPLAY_H_ #define DISPLAY_H_
@@ -297,3 +298,5 @@ extern void Display_feedRefreshCounter(struct Display* self);
extern void Display_feedRefreshCounterFromISR(struct Display* self); extern void Display_feedRefreshCounterFromISR(struct Display* self);
#endif /* DISPLAY_H_ */ #endif /* DISPLAY_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/DisplayContent.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * DisplayContent implementation
* \defgroup DisplayContent Package DisplayContent
/// @file DisplayContent.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef DISPLAYCONTENT_H_ #ifndef DISPLAYCONTENT_H_
#define DISPLAYCONTENT_H_ #define DISPLAYCONTENT_H_
@@ -176,3 +177,5 @@ extern void DisplayContent_refresh(struct DisplayContent* self);
extern void DisplayContent_clear(struct DisplayContent* self); extern void DisplayContent_clear(struct DisplayContent* self);
#endif /* DISPLAYCONTENT_H_ */ #endif /* DISPLAYCONTENT_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Displays.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Displays implementation
* \defgroup Displays Package Displays
/// @file Displays.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef DISPLAYS_H_ #ifndef DISPLAYS_H_
#define DISPLAYS_H_ #define DISPLAYS_H_
@@ -74,3 +75,5 @@ extern ErrorStatus Displays_construct(void);
*/ */
extern void Displays_destruct(void); extern void Displays_destruct(void);
#endif /* DISPLAYS_H_ */ #endif /* DISPLAYS_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * Error implementation
* \defgroup Error Package Error
/// @file Error.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef ERROR_H_ #ifndef ERROR_H_
#define ERROR_H_ #define ERROR_H_
@@ -124,3 +125,5 @@ extern void Error_postErrorFromISR(T_ErrorCode errorCode);
#endif /* ERROR_H_ */ #endif /* ERROR_H_ */
/** @} */

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

@@ -17,12 +17,12 @@
// (c) 2017 Micro-Key bv // (c) 2017 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * freeRTOSFixes implementation
* \defgroup freeRTOSFixes Package freeRTOSFixes
/// @file freeRTOSFixes.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef FREERTOSFIXES_H_ #ifndef FREERTOSFIXES_H_
#define FREERTOSFIXES_H_ #define FREERTOSFIXES_H_
@@ -55,3 +55,5 @@
void OS_logTaskInfo(xTaskHandle taskHandle); void OS_logTaskInfo(xTaskHandle taskHandle);
#endif /* FREERTOSFIXES_H_ */ #endif /* FREERTOSFIXES_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuCore.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MenuCore implementation
* \defgroup MenuCore Package MenuCore
/// @file MenuCore.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef MENUCORE_H_ #ifndef MENUCORE_H_
#define MENUCORE_H_ #define MENUCORE_H_
@@ -186,3 +187,5 @@ extern void MenuCore_changeState(struct MenuCore* self, T_MenuState newState);
#endif /* MENUCORE_H_ */ #endif /* MENUCORE_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuElements.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MenuElements implementation
* \defgroup MenuElements Package MenuElements
/// @file MenuElements.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef MENUELEMENTS_H_ #ifndef MENUELEMENTS_H_
#define 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); extern ErrorStatus MenuElements_addKeyAction_DIGITINSERTCONFIRM (struct MenuPage* self, char key, Keypad_KeyState keyState, MenuCoreFunctionCall actionPointer);
#endif /* MENUELEMENTS_H_ */ #endif /* MENUELEMENTS_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuStates.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MenuStates implementation
* \defgroup MenuStates Package MenuStates
/// @file MenuStates.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef MENUSTATES_H_ #ifndef MENUSTATES_H_
#define MENUSTATES_H_ #define MENUSTATES_H_
@@ -120,3 +121,5 @@ typedef enum
#endif /* MENUSTATES_H_ */ #endif /* MENUSTATES_H_ */
/** @} */

12
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/MenuText.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * MenuText implementation
* \defgroup MenuText Package MenuText
/// @file MenuText.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef MENUTEXT_H_ #ifndef MENUTEXT_H_
#define MENUTEXT_H_ #define MENUTEXT_H_
@@ -716,3 +717,4 @@ static const char MenuText_CALIBRATION_SETPOINTMENU[MENUTEXT_NUMBER_OF_LANGUAGES
#endif /* MENUTEXT_H_ */ #endif /* MENUTEXT_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIDParameters.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * PIDParameters implementation
* \defgroup PIDParameters Package PIDParameters
/// @file PIDParameters.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef PIDPARAMETERS_H_ #ifndef PIDPARAMETERS_H_
#define 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); extern void PIDParameters_setiMax(struct PIDParameters* self, int iMax);
#endif /* PIDPARAMETERS_H_ */ #endif /* PIDPARAMETERS_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PIN.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * PIN implementation
* \defgroup PIN Package PIN
/// @file PIN.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef PIN_H_ #ifndef PIN_H_
#define 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); extern ErrorStatus PIN_changePinSecondInsert(struct PIN* self, char* const secondPinInsert);
#endif /* PIN_H_ */ #endif /* PIN_H_ */
/** @} */

13
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/PowerLossDetector.h
View File

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * PowerLossDetector implementation
* \defgroup PowerLossDetector Package PowerLossDetector
/// @file PowerLossDetector.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef POWERLOSSDETECTOR_H_ #ifndef POWERLOSSDETECTOR_H_
#define POWERLOSSDETECTOR_H_ #define POWERLOSSDETECTOR_H_
@@ -116,3 +117,5 @@ extern void PowerLossDetector_clearBusyFlag(void);
extern bool PowerLossDetection_isFlagSet(void); extern bool PowerLossDetection_isFlagSet(void);
#endif /* POWERLOSSDETECTOR_H_ */ #endif /* POWERLOSSDETECTOR_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * hsb-mrts implementation
* \defgroup hsb-mrts Package hsb-mrts
/// @file hsb-mrts.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef HSB_MRTS_H_ #ifndef HSB_MRTS_H_
#define HSB_MRTS_H_ #define HSB_MRTS_H_
@@ -132,3 +133,5 @@ extern ErrorStatus hsb_enableSafetyWithWarning(void);
extern ErrorStatus hsb_disableSafety(void); extern ErrorStatus hsb_disableSafety(void);
extern bool hsb_safetyIsEnabled(void); extern bool hsb_safetyIsEnabled(void);
#endif /* HSB_MRTS_H_ */ #endif /* HSB_MRTS_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * hwValidationMenu implementation
* \defgroup hwValidationMenu Package hwValidationMenu
/// @file hwValidationMenu.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef INC_HWVALIDATIONMENU_H_ #ifndef INC_HWVALIDATIONMENU_H_
#define INC_HWVALIDATIONMENU_H_ #define INC_HWVALIDATIONMENU_H_
@@ -117,3 +118,5 @@ extern ErrorStatus HwValidationMenu_construct(struct HwValidationMenu* self, str
#endif /* INC_HWVALIDATIONMENU_H_ */ #endif /* INC_HWVALIDATIONMENU_H_ */
/** @} */

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

@@ -17,11 +17,12 @@
// (c) 2015 Micro-Key bv // (c) 2015 Micro-Key bv
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description} /**
/// Description * repairMenu implementation
* \defgroup repairMenu Package repairMenu
/// @file repairMenu.h * \ingroup hsb-mrts
/// @ingroup {group_name} * @{
*/
#ifndef INC_REPAIRMENU_H_ #ifndef INC_REPAIRMENU_H_
#define 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); extern void repairMenu_createMenuEntries(struct MenuCore* menuCore);
#endif /* INC_REPAIRMENU_H_ */ #endif /* INC_REPAIRMENU_H_ */
/** @} */