From ce1402f773314f5c9b1465bb6f8838b0d68188a9 Mon Sep 17 00:00:00 2001 From: guozhanxin Date: Fri, 10 Sep 2021 15:52:37 +0800 Subject: [kernel] Improve the code comment of the components.c --- src/components.c | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'src/components.c') diff --git a/src/components.c b/src/components.c index e156b783e4..2a4affdefb 100644 --- a/src/components.c +++ b/src/components.c @@ -78,7 +78,7 @@ static int rti_end(void) INIT_EXPORT(rti_end, "6.end"); /** - * RT-Thread Components Initialization for board + * @brief RT-Thread Components Initialization for board. */ void rt_components_board_init(void) { @@ -102,7 +102,7 @@ void rt_components_board_init(void) } /** - * RT-Thread Components Initialization + * @brief RT-Thread Components Initialization. */ void rt_components_init(void) { @@ -169,7 +169,11 @@ static rt_uint8_t main_stack[RT_MAIN_THREAD_STACK_SIZE]; struct rt_thread main_thread; #endif /* RT_USING_HEAP */ -/* the system main thread */ +/** + * @brief The system main thread. In this thread will call the rt_components_init() + * for initialization of RT-Thread Components and call the user's programming + * entry main(). + */ void main_thread_entry(void *parameter) { extern int main(void); @@ -193,6 +197,10 @@ void main_thread_entry(void *parameter) #endif } +/** + * @brief This function will create and start the main thread, but this thread + * will not run until the scheduler starts. + */ void rt_application_init(void) { rt_thread_t tid; @@ -216,6 +224,11 @@ void rt_application_init(void) rt_thread_startup(tid); } +/** + * @brief RT-Thread startup function. This function will call all levels of initialization + * functions to complete the initialization of the system, and finally start the + * scheduler. + */ int rtthread_startup(void) { rt_hw_interrupt_disable(); -- cgit v1.3.1 From e562c6f24bf3f857f11aa0bd82d46a6b4767464a Mon Sep 17 00:00:00 2001 From: guozhanxin Date: Fri, 10 Sep 2021 16:31:29 +0800 Subject: [kernel] 裁剪尾随空格 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/clock.c | 6 +++--- src/components.c | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'src/components.c') diff --git a/src/clock.c b/src/clock.c index 3b35e98d34..e49df94aae 100644 --- a/src/clock.c +++ b/src/clock.c @@ -46,7 +46,7 @@ RTM_EXPORT(rt_tick_get); /** * @brief This function will set current tick - * + * * @param tick is the value that you will set. */ void rt_tick_set(rt_tick_t tick) @@ -129,11 +129,11 @@ RTM_EXPORT(rt_tick_from_millisecond); /** * @brief This function will return the passed millisecond from boot. - * + * * @note When the value of RT_TICK_PER_SECOND is lower than 1000 or * is not an integral multiple of 1000, this function will not * provide the correct 1ms-based tick. - * + * * @return Return passed millisecond from boot */ RT_WEAK rt_tick_t rt_tick_get_millisecond(void) diff --git a/src/components.c b/src/components.c index 2a4affdefb..87e76091f2 100644 --- a/src/components.c +++ b/src/components.c @@ -199,7 +199,7 @@ void main_thread_entry(void *parameter) /** * @brief This function will create and start the main thread, but this thread - * will not run until the scheduler starts. + * will not run until the scheduler starts. */ void rt_application_init(void) { -- cgit v1.3.1 From 6cb093aa272a0b1ef908cbd8e103cbd94120b3c6 Mon Sep 17 00:00:00 2001 From: guozhanxin Date: Sat, 11 Sep 2021 18:29:37 +0800 Subject: [kernel] Improve code comments. --- src/clock.c | 2 +- src/components.c | 9 +++++---- src/cpu.c | 1 - 3 files changed, 6 insertions(+), 6 deletions(-) (limited to 'src/components.c') diff --git a/src/clock.c b/src/clock.c index e49df94aae..fb7ee447d2 100644 --- a/src/clock.c +++ b/src/clock.c @@ -130,7 +130,7 @@ RTM_EXPORT(rt_tick_from_millisecond); /** * @brief This function will return the passed millisecond from boot. * - * @note When the value of RT_TICK_PER_SECOND is lower than 1000 or + * @note if the value of RT_TICK_PER_SECOND is lower than 1000 or * is not an integral multiple of 1000, this function will not * provide the correct 1ms-based tick. * diff --git a/src/components.c b/src/components.c index 87e76091f2..9433b7457c 100644 --- a/src/components.c +++ b/src/components.c @@ -78,7 +78,9 @@ static int rti_end(void) INIT_EXPORT(rti_end, "6.end"); /** - * @brief RT-Thread Components Initialization for board. + * @brief Onboard components initialization. In this function, the board-level + * initialization function will be called to complete the initialization + * of the on-board peripherals. */ void rt_components_board_init(void) { @@ -225,9 +227,8 @@ void rt_application_init(void) } /** - * @brief RT-Thread startup function. This function will call all levels of initialization - * functions to complete the initialization of the system, and finally start the - * scheduler. + * @brief This function will call all levels of initialization functions to complete + * the initialization of the system, and finally start the scheduler. */ int rtthread_startup(void) { diff --git a/src/cpu.c b/src/cpu.c index 5466a350ae..b689ecf2d7 100644 --- a/src/cpu.c +++ b/src/cpu.c @@ -69,7 +69,6 @@ static void _cpu_preempt_enable(void) * @brief Initialize a static spinlock object. * * @param lock is a pointer to the spinlock to initialize. - * It is assumed that storage for the spinlock will be allocated in your application. */ void rt_spin_lock_init(struct rt_spinlock *lock) { -- cgit v1.3.1