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

Doxygen update

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@426 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-15 09:09:09 +00:00
parent b0eae7b776
commit 41ebc02741
22 changed files with 130 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

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

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

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

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

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

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */

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

@@ -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_ */
/** @} */