Skip to content

Commit 935b9b3

Browse files
authored
Update soft_timer.c
1 parent ef427fa commit 935b9b3

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

soft_timer.c

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ ton_t s_ton_obj[TON_ID_END];
2424

2525
/**
2626
* \fn void timer_check(uint8_t b_id, uint32_t dw_now)
27-
* \brief Start a periodic timer with a specified duration .
27+
* \brief
2828
*
29-
* \param t - variables are stored which function needs
30-
* \param now - system tick continuously running
31-
*
29+
* \param b_id
30+
* \param dw_now - system-tick continuously running
31+
* @retval none
3232
*/
3333
void timer_check(uint8_t b_id, uint32_t dw_now)
3434
{
@@ -54,32 +54,33 @@ void timer_check(uint8_t b_id, uint32_t dw_now)
5454
}
5555

5656
/**
57-
* \fn void timerStart(timeout_t*, uint32_t)
57+
* \fn void timer_start(uint8_t b_id)
5858
* \brief
59-
* \param s
60-
* \param interval
59+
* \param b_id
60+
* @retval none
6161
*/
6262
void timer_start(uint8_t b_id)
6363
{
6464
s_timer_obj[b_id].o_in = true;
6565
}
6666

6767
/**
68-
* \fn void timerStop(timeout_t*)
68+
* \fn void timer_stop(uint8_t b_id)
6969
* \brief
70-
* \param s
70+
* \param b_id
71+
* @retval none
7172
*/
7273
void timer_stop(uint8_t b_id)
7374
{
7475
s_timer_obj[b_id].o_in = false;
7576
}
7677

7778
/**
78-
* @brief void timer_set(uint8_t b_id, uint32_t dw_interval, void(*fp)(void))
79+
* \fn void timer_set(uint8_t b_id, uint32_t dw_interval, void(*fp)(void))
80+
* @brief
7981
* @param b_id
8082
* @param uint32_t dw_interval
8183
* @param void(*fp)(void)
82-
*
8384
* @retval none
8485
**/
8586
void timer_set(uint8_t b_id, uint32_t dw_interval, void(*fp)(void))
@@ -93,7 +94,7 @@ void timer_set(uint8_t b_id, uint32_t dw_interval, void(*fp)(void))
9394
* \brief Start a timer with a specified duration as on-delay.
9495
* \param b_id active TON obj selection
9596
* \param o_in - timer is executed when the "in" state changes from 0 to 1
96-
* \param dw_now - system tick continuously running
97+
* \param dw_now - system-tick continuously running
9798
* \param dw_preset_time - timer is started for the time stored in
9899
* \return if time is over , return value is 1
99100
*/

0 commit comments

Comments
 (0)