Browse Source

doxygen: group name all in lowcase

This patch only updated the groups defined in documentation/0.doxygen.

Other groups will be moved into documentation/0.doxygen and updated at
that time.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Chen Wang 1 month ago
parent
commit
8e9872a554

+ 1 - 1
components/dfs/dfs_v1/src/dfs.c

@@ -38,7 +38,7 @@ static struct dfs_fdtable _fdtab;
 static int  fd_alloc(struct dfs_fdtable *fdt, int startfd);
 
 /**
- * @addtogroup group_DFS
+ * @addtogroup group_device_virtual_file_system
  * @{
  */
 

+ 1 - 1
components/dfs/dfs_v2/src/dfs.c

@@ -139,7 +139,7 @@ void dfs_unlock(void)
     rt_mutex_release(&fslock);
 }
 
-/** @addtogroup group_DFS
+/** @addtogroup group_device_virtual_file_system
  *
  *
  *  @{

+ 1 - 1
documentation/0.doxygen/0.basicdef.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup group_BasicDef Basic Definitions
+ * @defgroup group_basic_definition Basic Definitions
  *
  * @brief Basic data type in RT-Thread RTOS.
  *

+ 9 - 9
documentation/0.doxygen/1.core.h

@@ -14,7 +14,7 @@
  */
 
 /**
- * @defgroup group_KernelObject Kernel Object Management
+ * @defgroup group_kernel_object Kernel Object Management
  * @brief See @ref section_kernel_object_model
  *
  * The Kernel object system can access and manage all of the kernel objects.
@@ -34,22 +34,22 @@
  */
 
 /**
- * @defgroup group_Thread Thread Management
+ * @defgroup group_thread_management Thread Management
  * @brief See @ref page_thread_management
  */
 
 /**
- * @defgroup group_Clock Clock and Timer Management
+ * @defgroup group_clock_management Clock and Timer Management
  * @brief See @ref page_clock_management
  */
 
 /**
- * @defgroup group_IPC Inter-Thread Communication
+ * @defgroup group_thread_comm Inter-Thread Communication
  * @brief See @ref page_thread_comm
  */
 
 /**
- * @defgroup group_MM Memory Management
+ * @defgroup group_memory_management Memory Management
  * @brief memory management for memory pool and heap memory
  *
  * RT-Thread operating system supports two types memory management:
@@ -68,7 +68,7 @@
  */
 
 /**
- * @defgroup group_Hook Runtime Trace and Record
+ * @defgroup group_hook Runtime Trace and Record
  * @brief the hook function set in runtime
  *
  * In order to trace and record RT-Thread activity in runtime, a hook mechanism
@@ -83,12 +83,12 @@
  */
 
 /**
- * @defgroup group_KernelService Other useful kernel service
+ * @defgroup group_kernel_service Other useful kernel service
  * @brief other useful service in the kernel
  */
 
 /**
- * @defgroup group_Error Error Code
+ * @defgroup group_error Error Code
  * @brief error code
  *
  * The error code is defined to identify which kind of error occurs. When some
@@ -96,7 +96,7 @@
  */
 
 /**
- * @defgroup group_SystemInit System Initialization
+ * @defgroup group_system_init System Initialization
  *
  * @brief System initialization procedure.
  *

+ 2 - 2
documentation/0.doxygen/2.components.h

@@ -20,7 +20,7 @@
  */
 
 /**
- * @defgroup group_DFS Device Virtual File System
+ * @defgroup group_device_virtual_file_system Device Virtual File System
  *
  * @brief DFS is a virtual file system in RT-Thread RTOS.
  *
@@ -68,7 +68,7 @@
  */
 
 /**
- * @defgroup group_Module Application Module
+ * @defgroup group_module Application Module
  *
  * @brief Application Module is a feature let user to execute application in RT-Thread RTOS.
  *

+ 1 - 1
documentation/0.doxygen/components/filesystem.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @addtogroup group_DFS
+ * @addtogroup group_device_virtual_file_system
  * @{
  */
 

+ 1 - 1
documentation/0.doxygen/core/ipc.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @addtogroup group_IPC
+ * @addtogroup group_thread_comm
  * @{
  */
 

+ 2 - 2
documentation/0.doxygen/core/systeminit.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @ingroup group_SystemInit
+ * @ingroup group_system_init
  *
  * This function will initialize user application.
  *
@@ -14,6 +14,6 @@
 void rt_application_init();
 
 /**
- * @ingroup group_SystemInit
+ * @ingroup group_system_init
  */
 void rt_system_heap_init(void* begin_addr, void* end_addr);

+ 1 - 1
documentation/0.doxygen/core/thread.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  * @{
  */
 

+ 11 - 11
include/rtdef.h

@@ -75,7 +75,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup group_BasicDef
+ * @addtogroup group_basic_definition
  */
 
 /**@{*/
@@ -235,7 +235,7 @@ typedef int (*init_fn_t)(void);
 #endif /* RT_KERNEL_REALLOC */
 
 /**
- * @ingroup group_BasicDef
+ * @ingroup group_basic_definition
  *
  * @def RT_IS_ALIGN(addr, align)
  * Return true(1) or false(0).
@@ -246,7 +246,7 @@ typedef int (*init_fn_t)(void);
 #define RT_IS_ALIGN(addr, align) ((!(addr & (align - 1))) && (addr != RT_NULL))
 
 /**
- * @ingroup group_BasicDef
+ * @ingroup group_basic_definition
  *
  * @def RT_ALIGN(size, align)
  * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
@@ -256,7 +256,7 @@ typedef int (*init_fn_t)(void);
 #define RT_ALIGN(size, align)           (((size) + (align) - 1) & ~((align) - 1))
 
 /**
- * @ingroup group_BasicDef
+ * @ingroup group_basic_definition
  *
  * @def RT_ALIGN_DOWN(size, align)
  * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
@@ -266,7 +266,7 @@ typedef int (*init_fn_t)(void);
 #define RT_ALIGN_DOWN(size, align)      ((size) & ~((align) - 1))
 
 /**
- * @addtogroup group_KernelObject
+ * @addtogroup group_kernel_object
  */
 
 /**@{*/
@@ -515,7 +515,7 @@ struct rt_object_information
 /**@}*/
 
 /**
- * @addtogroup group_Clock
+ * @addtogroup group_clock_management
  */
 
 /**@{*/
@@ -591,7 +591,7 @@ typedef void (*rt_sighandler_t)(int signo);
 /**@}*/
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  */
 
 /**@{*/
@@ -964,7 +964,7 @@ typedef struct rt_thread *rt_thread_t;
 /**@}*/
 
 /**
- * @addtogroup group_IPC
+ * @addtogroup group_thread_comm
  */
 
 /**@{*/
@@ -972,8 +972,8 @@ typedef struct rt_thread *rt_thread_t;
 /**
  * IPC flags and control command definitions
  */
-#define RT_IPC_FLAG_FIFO                0x00            /**< FIFOed IPC. @ref group_IPC. */
-#define RT_IPC_FLAG_PRIO                0x01            /**< PRIOed IPC. @ref group_IPC. */
+#define RT_IPC_FLAG_FIFO                0x00            /**< FIFOed IPC. @ref group_thread_comm. */
+#define RT_IPC_FLAG_PRIO                0x01            /**< PRIOed IPC. @ref group_thread_comm. */
 
 #define RT_IPC_CMD_UNKNOWN              0x00            /**< unknown IPC command */
 #define RT_IPC_CMD_RESET                0x01            /**< reset IPC object */
@@ -1134,7 +1134,7 @@ typedef struct rt_messagequeue *rt_mq_t;
 /**@}*/
 
 /**
- * @addtogroup group_MM
+ * @addtogroup group_memory_management
  */
 
 /**@{*/

+ 1 - 1
include/rtservice.h

@@ -24,7 +24,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup group_KernelService
+ * @addtogroup group_kernel_service
  */
 
 /**@{*/

+ 7 - 7
include/rtthread.h

@@ -50,7 +50,7 @@ int entry(void);
 #endif
 
 /**
- * @addtogroup group_KernelObject
+ * @addtogroup group_kernel_object
  * @{
  */
 
@@ -90,7 +90,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object));
 /**@}*/
 
 /**
- * @addtogroup group_Clock
+ * @addtogroup group_clock_management
  * @{
  */
 
@@ -139,7 +139,7 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer));
 /**@}*/
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  * @{
  */
 
@@ -262,7 +262,7 @@ int rt_system_signal_init(void);
 /**@}*/
 
 /**
- * @addtogroup group_MM
+ * @addtogroup group_memory_management
  * @{
  */
 
@@ -318,7 +318,7 @@ void rt_page_free(void *addr, rt_size_t npages);
 #endif /* defined(RT_USING_SLAB) && defined(RT_USING_SLAB_AS_HEAP) */
 
 /**
- * @ingroup group_Hook
+ * @ingroup group_hook
  * @{
  */
 
@@ -388,7 +388,7 @@ void rt_slab_free(rt_slab_t m, void *ptr);
 /**@}*/
 
 /**
- * @addtogroup group_IPC
+ * @addtogroup group_thread_comm
  * @{
  */
 
@@ -762,7 +762,7 @@ void rt_components_board_init(void);
 #endif /* RT_USING_COMPONENTS_INIT */
 
 /**
- * @addtogroup group_KernelService
+ * @addtogroup group_kernel_service
  * @{
  */
 

+ 2 - 2
src/clock.c

@@ -37,7 +37,7 @@ static volatile rt_atomic_t rt_tick = 0;
 static void (*rt_tick_hook)(void);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -56,7 +56,7 @@ void rt_tick_sethook(void (*hook)(void))
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup group_Clock
+ * @addtogroup group_clock_management
  */
 
 /**@{*/

+ 1 - 1
src/ipc.c

@@ -63,7 +63,7 @@ extern void (*rt_object_put_hook)(struct rt_object *object);
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup group_IPC
+ * @addtogroup group_thread_comm
  * @{
  */
 

+ 2 - 2
src/irq.c

@@ -30,7 +30,7 @@ static void (*rt_interrupt_enter_hook)(void);
 static void (*rt_interrupt_leave_hook)(void);
 
 /**
- * @ingroup group_Hook
+ * @ingroup group_hook
  *
  * @brief This function set a hook function when the system enter a interrupt
  *
@@ -44,7 +44,7 @@ void rt_interrupt_enter_sethook(void (*hook)(void))
 }
 
 /**
- * @ingroup group_Hook
+ * @ingroup group_hook
  *
  * @brief This function set a hook function when the system exit a interrupt.
  *

+ 2 - 2
src/kservice.c

@@ -54,7 +54,7 @@
 #endif
 
 /**
- * @addtogroup group_KernelService
+ * @addtogroup group_kernel_service
  * @{
  */
 
@@ -589,7 +589,7 @@ static void (*rt_realloc_exit_hook)(void **ptr, rt_size_t size);
 static void (*rt_free_hook)(void **ptr);
 
 /**
- * @ingroup group_Hook
+ * @ingroup group_hook
  * @{
  */
 

+ 1 - 1
src/mem.c

@@ -254,7 +254,7 @@ rt_err_t rt_smem_detach(rt_smem_t m)
 RTM_EXPORT(rt_smem_detach);
 
 /**
- * @addtogroup group_MM
+ * @addtogroup group_memory_management
  */
 
 /**@{*/

+ 2 - 2
src/mempool.c

@@ -29,7 +29,7 @@ static void (*rt_mp_alloc_hook)(struct rt_mempool *mp, void *block);
 static void (*rt_mp_free_hook)(struct rt_mempool *mp, void *block);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -60,7 +60,7 @@ void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block))
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup group_MM
+ * @addtogroup group_memory_management
  */
 
 /**@{*/

+ 2 - 2
src/object.c

@@ -152,7 +152,7 @@ void (*rt_object_take_hook)(struct rt_object *object);
 void (*rt_object_put_hook)(struct rt_object *object);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -231,7 +231,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup group_KernelObject
+ * @addtogroup group_kernel_object
  */
 
 /**@{*/

+ 2 - 2
src/scheduler_mp.c

@@ -145,7 +145,7 @@ static void (*rt_scheduler_hook)(struct rt_thread *from, struct rt_thread *to);
 static void (*rt_scheduler_switch_hook)(struct rt_thread *tid);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -520,7 +520,7 @@ void rt_system_scheduler_start(void)
 }
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  * @cond
  */
 

+ 2 - 2
src/scheduler_up.c

@@ -56,7 +56,7 @@ static void (*rt_scheduler_hook)(struct rt_thread *from, struct rt_thread *to);
 static void (*rt_scheduler_switch_hook)(struct rt_thread *tid);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -247,7 +247,7 @@ void rt_system_scheduler_start(void)
 }
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  * @cond
  */
 

+ 1 - 1
src/slab.c

@@ -469,7 +469,7 @@ rt_inline int zoneindex(rt_size_t *bytes)
 }
 
 /**
- * @addtogroup group_MM
+ * @addtogroup group_memory_management
  */
 
 /**@{*/

+ 1 - 1
src/thread.c

@@ -297,7 +297,7 @@ static rt_err_t _thread_init(struct rt_thread *thread,
 }
 
 /**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
  */
 
 /**@{*/

+ 4 - 4
src/timer.c

@@ -63,7 +63,7 @@ static void (*rt_timer_enter_hook)(struct rt_timer *timer);
 static void (*rt_timer_exit_hook)(struct rt_timer *timer);
 
 /**
- * @addtogroup group_Hook
+ * @addtogroup group_hook
  */
 
 /**@{*/
@@ -240,7 +240,7 @@ void rt_timer_dump(rt_list_t timer_heads[])
 #endif /* (DBG_LVL == DBG_LOG) */
 
 /**
- * @addtogroup group_Clock
+ * @addtogroup group_clock_management
  */
 
 /**@{*/
@@ -816,7 +816,7 @@ static void _timer_thread_entry(void *parameter)
 #endif /* RT_USING_TIMER_SOFT */
 
 /**
- * @ingroup group_SystemInit
+ * @ingroup group_system_init
  *
  * @brief This function will initialize system timer
  */
@@ -835,7 +835,7 @@ void rt_system_timer_init(void)
 }
 
 /**
- * @ingroup group_SystemInit
+ * @ingroup group_system_init
  *
  * @brief This function will initialize system timer thread
  */