Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h')
-rw-r--r--runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h17
1 files changed, 12 insertions, 5 deletions
diff --git a/runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h b/runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h
index 6ac5f0a48..827c2a025 100644
--- a/runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h
+++ b/runtime/org.eclipse.etrice.runtime.c/src/common/osal/etTimer.h
@@ -10,6 +10,13 @@
*
*******************************************************************************/
+/**
+ * \file etTimer.h
+ *
+ * a timer abstraction
+ *
+ * \author Thomas Jung
+ */
#ifndef _ETTIMER_H_
#define _ETTIMER_H_
@@ -25,12 +32,12 @@ typedef void (*etTimerFunction)(void* data);
/**
* etThread holds all data needed to handle a thread instance
* the struct has to be filled before calling etThread_construct except for osData and osId
- **/
+ */
typedef struct etTimer{
- etTime timerInterval; /**< timer interval **/
- etTimerFunction timerFunction; /**< call back function to be called by timer -> has to be filled in by caller of etTimer_construct **/
- void* timerFunctionData; /**< the data that are passed to the timer function **/
- etOSTimerData osTimerData; /**< OS specific timer id (e.g. handle or id) -> is filled in by etTimer_construct **/
+ etTime timerInterval; /**< timer interval */
+ etTimerFunction timerFunction; /**< call back function to be called by timer -> has to be filled in by caller of etTimer_construct */
+ void* timerFunctionData; /**< the data that are passed to the timer function */
+ etOSTimerData osTimerData; /**< OS specific timer id (e.g. handle or id) -> is filled in by etTimer_construct */
} etTimer;
/**

Back to the top