From d507755bd8ab997827f94adff5882ff6e130247f Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 09:56:03 +0800 Subject: [PATCH 01/13] Update rtthread.h Correct comments about doxygen format --- include/rtthread.h | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/include/rtthread.h b/include/rtthread.h index 6ab1ed9069..4091e538f8 100644 --- a/include/rtthread.h +++ b/include/rtthread.h @@ -46,7 +46,7 @@ extern "C" { * @addtogroup KernelObject */ -/*@{*/ +/**@{*/ /* * kernel object interface @@ -72,13 +72,13 @@ void rt_object_take_sethook(void (*hook)(struct rt_object *object)); void rt_object_put_sethook(void (*hook)(struct rt_object *object)); #endif -/*@}*/ +/**@}*/ /** * @addtogroup Clock */ -/*@{*/ +/**@{*/ /* * clock & timer interface @@ -116,13 +116,13 @@ void rt_timer_check(void); void rt_timer_timeout_sethook(void (*hook)(struct rt_timer *timer)); #endif -/*@}*/ +/**@}*/ /** * @addtogroup Thread */ -/*@{*/ +/**@{*/ /* * thread interface @@ -187,13 +187,13 @@ rt_uint16_t rt_critical_level(void); void rt_scheduler_sethook(void (*hook)(rt_thread_t from, rt_thread_t to)); #endif -/*@}*/ +/**@}*/ /** * @addtogroup MM */ -/*@{*/ +/**@{*/ /* * memory management interface @@ -266,13 +266,13 @@ void *rt_memheap_realloc(struct rt_memheap* heap, void* ptr, rt_size_t newsize); void rt_memheap_free(void *ptr); #endif -/*@}*/ +/**@}*/ /** * @addtogroup IPC */ -/*@{*/ +/**@{*/ #ifdef RT_USING_SEMAPHORE /* @@ -371,14 +371,14 @@ rt_err_t rt_mq_recv(rt_mq_t mq, rt_err_t rt_mq_control(rt_mq_t mq, rt_uint8_t cmd, void *arg); #endif -/*@}*/ +/**@}*/ #ifdef RT_USING_DEVICE /** * @addtogroup Device */ -/*@{*/ +/**@{*/ /* * device (I/O) system interface @@ -411,7 +411,7 @@ rt_size_t rt_device_write(rt_device_t dev, rt_size_t size); rt_err_t rt_device_control(rt_device_t dev, rt_uint8_t cmd, void *arg); -/*@}*/ +/**@}*/ #endif #ifdef RT_USING_MODULE @@ -419,7 +419,7 @@ rt_err_t rt_device_control(rt_device_t dev, rt_uint8_t cmd, void *arg); * @addtogroup Module */ -/*@{*/ +/**@{*/ /* * module interface @@ -449,7 +449,7 @@ rt_err_t rt_module_destroy(rt_module_t module); */ int rt_system_module_init(void); -/*@}*/ +/**@}*/ #endif /* @@ -481,7 +481,7 @@ void rt_components_board_init(void); * @addtogroup KernelService */ -/*@{*/ +/**@{*/ /* * general kernel service @@ -534,7 +534,7 @@ void rt_assert_set_hook(void (*hook)(const char* ex, const char* func, rt_size_t void rt_assert_handler(const char* ex, const char* func, rt_size_t line); #endif /* RT_DEBUG */ -/*@}*/ +/**@}*/ #ifdef __cplusplus } From b54e72275a009d9f58840416b0ba9a6327b8dd3d Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:05:00 +0800 Subject: [PATCH 02/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/clock.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/clock.c b/src/clock.c index 63f65b874a..36e26238ed 100644 --- a/src/clock.c +++ b/src/clock.c @@ -50,7 +50,7 @@ void rt_system_tick_init(void) * @addtogroup Clock */ -/*@{*/ +/**@{*/ /** * This function will return current tick from operating system startup @@ -118,5 +118,5 @@ rt_tick_t rt_tick_from_millisecond(rt_uint32_t ms) } RTM_EXPORT(rt_tick_from_millisecond); -/*@}*/ +/**@}*/ From c314417e0b0182c98e3d3c94e0a453b48c09fe2d Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:07:12 +0800 Subject: [PATCH 03/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/ipc.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/ipc.c b/src/ipc.c index 8c12f701b0..9ecd602099 100644 --- a/src/ipc.c +++ b/src/ipc.c @@ -61,7 +61,7 @@ extern void (*rt_object_put_hook)(struct rt_object *object); * @addtogroup IPC */ -/*@{*/ +/**@{*/ /** * This function will initialize an IPC object @@ -2281,4 +2281,4 @@ rt_err_t rt_mq_control(rt_mq_t mq, rt_uint8_t cmd, void *arg) RTM_EXPORT(rt_mq_control); #endif /* end of RT_USING_MESSAGEQUEUE */ -/*@}*/ +/**@}*/ From 50393389ff2a4723d7fe243150417a2c452edcd5 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:08:35 +0800 Subject: [PATCH 04/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/irq.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/irq.c b/src/irq.c index ca221cf10d..9b933e3960 100644 --- a/src/irq.c +++ b/src/irq.c @@ -60,7 +60,7 @@ void rt_interrupt_leave_sethook(void (*hook)(void)) * @addtogroup Kernel */ -/*@{*/ +/**@{*/ volatile rt_uint8_t rt_interrupt_nest; @@ -123,5 +123,5 @@ RTM_EXPORT(rt_interrupt_get_nest); RTM_EXPORT(rt_hw_interrupt_disable); RTM_EXPORT(rt_hw_interrupt_enable); -/*@}*/ +/**@}*/ From 4c9bd71f22da74ca009e706ede5eeee500a992e6 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:10:26 +0800 Subject: [PATCH 05/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/kservice.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/kservice.c b/src/kservice.c index f5cd934e2d..614399e1e0 100644 --- a/src/kservice.c +++ b/src/kservice.c @@ -43,7 +43,7 @@ * @addtogroup KernelService */ -/*@{*/ +/**@{*/ /* global errno in RT-Thread */ static volatile int _errno; @@ -1328,4 +1328,4 @@ int vsprintf(char *buf, const char *format, va_list arg_ptr) __attribute__((weak #endif -/*@}*/ +/**@}*/ From 3e249d21699154cb1477cf257eaa0871f6fe0356 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:11:38 +0800 Subject: [PATCH 06/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/mem.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/mem.c b/src/mem.c index c45059c5cd..b19e46d524 100644 --- a/src/mem.c +++ b/src/mem.c @@ -76,7 +76,7 @@ static void (*rt_free_hook)(void *ptr); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when a memory @@ -100,7 +100,7 @@ void rt_free_sethook(void (*hook)(void *ptr)) rt_free_hook = hook; } -/*@}*/ +/**@}*/ #endif @@ -234,7 +234,7 @@ void rt_system_heap_init(void *begin_addr, void *end_addr) * @addtogroup MM */ -/*@{*/ +/**@{*/ /** * Allocate a block of memory with a minimum of 'size' bytes. @@ -585,7 +585,7 @@ FINSH_FUNCTION_EXPORT(list_mem, list memory usage information) #endif #endif -/*@}*/ +/**@}*/ #endif /* end of RT_USING_HEAP */ #endif /* end of RT_USING_MEMHEAP_AS_HEAP */ From aff68a36cdca05e129a29784314a60e9fe5b665b Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:12:39 +0800 Subject: [PATCH 07/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/mempool.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/mempool.c b/src/mempool.c index b6d83597bf..a01e2145c3 100644 --- a/src/mempool.c +++ b/src/mempool.c @@ -43,7 +43,7 @@ static void (*rt_mp_free_hook)(struct rt_mempool *mp, void *block); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when a memory @@ -67,14 +67,14 @@ void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block)) rt_mp_free_hook = hook; } -/*@}*/ +/**@}*/ #endif /** * @addtogroup MM */ -/*@{*/ +/**@{*/ /** * This function will initialize a memory pool object, normally which is used @@ -465,7 +465,7 @@ void rt_mp_free(void *block) } RTM_EXPORT(rt_mp_free); -/*@}*/ +/**@}*/ #endif From 91fb7ee1d63270cb381a0fb5d1915c136333d2a7 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:13:58 +0800 Subject: [PATCH 08/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/module.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/module.c b/src/module.c index b03611a4f4..79ac0c8688 100644 --- a/src/module.c +++ b/src/module.c @@ -366,7 +366,7 @@ static void (*rt_module_unload_hook)(rt_module_t module); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when module @@ -390,7 +390,7 @@ void rt_module_unload_sethook(void (*hook)(rt_module_t module)) rt_module_unload_hook = hook; } -/*@}*/ +/**@}*/ #endif static struct rt_module *_load_shared_object(const char *name, From ed7088024dedeef268ef91f8c4315837e0ac3d56 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:15:10 +0800 Subject: [PATCH 09/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/object.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/object.c b/src/object.c index ae8234f47d..d71f792b5d 100644 --- a/src/object.c +++ b/src/object.c @@ -87,7 +87,7 @@ void (*rt_object_put_hook)(struct rt_object *object); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when object @@ -159,7 +159,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object)) rt_object_put_hook = hook; } -/*@}*/ +/**@}*/ #endif /** @@ -178,7 +178,7 @@ void rt_system_object_init(void) * @addtogroup KernelObject */ -/*@{*/ +/**@{*/ /** * This function will return the specified type of object information. @@ -494,4 +494,4 @@ rt_object_t rt_object_find(const char *name, rt_uint8_t type) return RT_NULL; } -/*@}*/ +/**@}*/ From 70d34bce3c3d0971b7c349e9ad0d92e106dc203e Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:16:07 +0800 Subject: [PATCH 10/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/scheduler.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/scheduler.c b/src/scheduler.c index d011ebfacd..5cc2f0b067 100644 --- a/src/scheduler.c +++ b/src/scheduler.c @@ -67,7 +67,7 @@ static void (*rt_scheduler_hook)(struct rt_thread *from, struct rt_thread *to); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when thread @@ -81,7 +81,7 @@ rt_scheduler_sethook(void (*hook)(struct rt_thread *from, struct rt_thread *to)) rt_scheduler_hook = hook; } -/*@}*/ +/**@}*/ #endif #ifdef RT_USING_OVERFLOW_CHECK @@ -183,7 +183,7 @@ void rt_system_scheduler_start(void) * @addtogroup Thread */ -/*@{*/ +/**@{*/ /** * This function will perform one schedule. It will select one thread @@ -412,5 +412,5 @@ rt_uint16_t rt_critical_level(void) return rt_scheduler_lock_nest; } RTM_EXPORT(rt_critical_level); -/*@}*/ +/**@}*/ From beb005e20d67d6b0f36de71abdf995900d9c32d1 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:17:36 +0800 Subject: [PATCH 11/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/slab.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/slab.c b/src/slab.c index 78355d0e46..d1093a7a93 100644 --- a/src/slab.c +++ b/src/slab.c @@ -81,7 +81,7 @@ static void (*rt_free_hook)(void *ptr); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when a memory @@ -107,7 +107,7 @@ void rt_free_sethook(void (*hook)(void *ptr)) } RTM_EXPORT(rt_free_sethook); -/*@}*/ +/**@}*/ #endif @@ -472,7 +472,7 @@ rt_inline int zoneindex(rt_uint32_t *bytes) * @addtogroup MM */ -/*@{*/ +/**@{*/ /** * This function will allocate a block from system heap memory. @@ -963,6 +963,6 @@ FINSH_FUNCTION_EXPORT(list_mem, list memory usage information) #endif #endif -/*@}*/ +/**@}*/ #endif From 2bfacd85ae863505c7d1d364bb5ae872982e2ec7 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:18:38 +0800 Subject: [PATCH 12/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/thread.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/thread.c b/src/thread.c index b8b582d5be..ec7bfdefbd 100644 --- a/src/thread.c +++ b/src/thread.c @@ -169,7 +169,7 @@ static rt_err_t _rt_thread_init(struct rt_thread *thread, * @addtogroup Thread */ -/*@{*/ +/**@{*/ /** * This function will initialize a thread, normally it's used to initialize a @@ -737,4 +737,4 @@ rt_thread_t rt_thread_find(char *name) } RTM_EXPORT(rt_thread_find); -/*@}*/ +/**@}*/ From 20fb863ddf3e21865872d747c948df9bb677aa05 Mon Sep 17 00:00:00 2001 From: dogandog Date: Fri, 19 Aug 2016 10:19:46 +0800 Subject: [PATCH 13/13] Correct comments about doxygen format chang /*@{*/ to /**@{*/ and /*@}*/ to /**@}*/ --- src/timer.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/timer.c b/src/timer.c index ba2801530d..e34d229be4 100644 --- a/src/timer.c +++ b/src/timer.c @@ -63,7 +63,7 @@ static void (*rt_timer_timeout_hook)(struct rt_timer *timer); * @addtogroup Hook */ -/*@{*/ +/**@{*/ /** * This function will set a hook function, which will be invoked when timer @@ -76,7 +76,7 @@ void rt_timer_timeout_sethook(void (*hook)(struct rt_timer *timer)) rt_timer_timeout_hook = hook; } -/*@}*/ +/**@}*/ #endif static void _rt_timer_init(rt_timer_t timer, @@ -164,7 +164,7 @@ void rt_timer_dump(rt_list_t timer_heads[]) * @addtogroup Clock */ -/*@{*/ +/**@{*/ /** * This function will initialize a timer, normally this function is used to @@ -710,4 +710,4 @@ void rt_system_timer_thread_init(void) #endif } -/*@}*/ +/**@}*/