Skip to content

Commit 6cb093a

Browse files
committed
[kernel] Improve code comments.
1 parent e6f5282 commit 6cb093a

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

src/clock.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ RTM_EXPORT(rt_tick_from_millisecond);
130130
/**
131131
* @brief This function will return the passed millisecond from boot.
132132
*
133-
* @note When the value of RT_TICK_PER_SECOND is lower than 1000 or
133+
* @note if the value of RT_TICK_PER_SECOND is lower than 1000 or
134134
* is not an integral multiple of 1000, this function will not
135135
* provide the correct 1ms-based tick.
136136
*

src/components.c

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ static int rti_end(void)
7878
INIT_EXPORT(rti_end, "6.end");
7979

8080
/**
81-
* @brief RT-Thread Components Initialization for board.
81+
* @brief Onboard components initialization. In this function, the board-level
82+
* initialization function will be called to complete the initialization
83+
* of the on-board peripherals.
8284
*/
8385
void rt_components_board_init(void)
8486
{
@@ -225,9 +227,8 @@ void rt_application_init(void)
225227
}
226228

227229
/**
228-
* @brief RT-Thread startup function. This function will call all levels of initialization
229-
* functions to complete the initialization of the system, and finally start the
230-
* scheduler.
230+
* @brief This function will call all levels of initialization functions to complete
231+
* the initialization of the system, and finally start the scheduler.
231232
*/
232233
int rtthread_startup(void)
233234
{

src/cpu.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ static void _cpu_preempt_enable(void)
6969
* @brief Initialize a static spinlock object.
7070
*
7171
* @param lock is a pointer to the spinlock to initialize.
72-
* It is assumed that storage for the spinlock will be allocated in your application.
7372
*/
7473
void rt_spin_lock_init(struct rt_spinlock *lock)
7574
{

0 commit comments

Comments
 (0)