gtimer doxygen fix
parent
9f2a7c36d9
commit
b0fbfdebba
|
@ -90,85 +90,10 @@ typedef struct GTimer_t {
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Initialise a timer.
|
|
||||||
*
|
|
||||||
* @param[in] pt pointer to a GTimer structure
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
|
||||||
void gtimerInit(GTimer *pt);
|
void gtimerInit(GTimer *pt);
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Set a timer going or alter its properties if it is already going.
|
|
||||||
*
|
|
||||||
* @param[in] pt Pointer to a GTimer structure
|
|
||||||
* @param[in] fn The callback function
|
|
||||||
* @param[in] param The parameter to pass to the callback function
|
|
||||||
* @param[in] periodic Is the timer a periodic timer? FALSE is a once-only timer.
|
|
||||||
* @param[in] millisec The timer period. The following special values are allowed:
|
|
||||||
* TIME_IMMEDIATE causes the callback function to be called asap.
|
|
||||||
* A periodic timer with this value will fire once only.
|
|
||||||
* TIME_INFINITE never timeout (unless triggered by gtimerJab or gtimerJabI)
|
|
||||||
*
|
|
||||||
* @note If the timer is already active its properties are updated with the new parameters.
|
|
||||||
* The current period will be immediately canceled (without the callback function being
|
|
||||||
* called) and the timer will be restart with the new timer properties.
|
|
||||||
* @note The callback function should be careful not to over-run the thread stack.
|
|
||||||
* Define a new value for the macro GTIME_THREAD_STACK_SIZE if you want to
|
|
||||||
* change the default size.
|
|
||||||
* @note The callback function should return as quickly as possible as all
|
|
||||||
* timer callbacks are performed by a single thread. If a callback function
|
|
||||||
* takes too long it could affect the timer response for other timers.
|
|
||||||
* @note A timer callback function is not a replacement for a dedicated thread if the
|
|
||||||
* function wants to perform computationally expensive stuff.
|
|
||||||
* @note As the callback function is called on GTIMER's thread, the function must make sure it uses
|
|
||||||
* appropriate synchronisation controls such as semaphores or mutexes around any data
|
|
||||||
* structures it shares with other threads such as the main application thread.
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
|
||||||
void gtimerStart(GTimer *pt, GTimerFunction fn, void *param, bool_t periodic, systime_t millisec);
|
void gtimerStart(GTimer *pt, GTimerFunction fn, void *param, bool_t periodic, systime_t millisec);
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Stop a timer (periodic or otherwise)
|
|
||||||
*
|
|
||||||
* @param[in] pt Pointer to a GTimer structure
|
|
||||||
*
|
|
||||||
* @note If the timer is not active this does nothing.
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
|
||||||
void gtimerStop(GTimer *pt);
|
void gtimerStop(GTimer *pt);
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Jab a timer causing the current period to immediate expire
|
|
||||||
* @details The callback function will be called as soon as possible.
|
|
||||||
*
|
|
||||||
* @pre Use from a normal thread context.
|
|
||||||
*
|
|
||||||
* @param[in] pt Pointer to a GTimer structure
|
|
||||||
*
|
|
||||||
* @note If the timer is not active this does nothing.
|
|
||||||
* @note Repeated Jabs before the callback function actually happens are ignored.
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
|
||||||
void gtimerJab(GTimer *pt);
|
void gtimerJab(GTimer *pt);
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Jab a timer causing the current period to immediate expire
|
|
||||||
* @details The callback function will be called as soon as possible.
|
|
||||||
*
|
|
||||||
* @pre Use from an interrupt routine context.
|
|
||||||
*
|
|
||||||
* @param[in] pt Pointer to a GTimer structure
|
|
||||||
*
|
|
||||||
* @note If the timer is not active this does nothing.
|
|
||||||
* @note Repeated Jabs before the callback function actually happens are ignored.
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
|
||||||
void gtimerJabI(GTimer *pt);
|
void gtimerJabI(GTimer *pt);
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -179,3 +104,4 @@ void gtimerJabI(GTimer *pt);
|
||||||
|
|
||||||
#endif /* _GTIMER_H */
|
#endif /* _GTIMER_H */
|
||||||
/** @} */
|
/** @} */
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue