Skip to content

Commit 8e9872a

Browse files
unicornxRbb666
authored andcommitted
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 <[email protected]>
1 parent 29ab533 commit 8e9872a

File tree

24 files changed

+60
-60
lines changed

24 files changed

+60
-60
lines changed

components/dfs/dfs_v1/src/dfs.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ static struct dfs_fdtable _fdtab;
3838
static int fd_alloc(struct dfs_fdtable *fdt, int startfd);
3939

4040
/**
41-
* @addtogroup group_DFS
41+
* @addtogroup group_device_virtual_file_system
4242
* @{
4343
*/
4444

components/dfs/dfs_v2/src/dfs.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ void dfs_unlock(void)
139139
rt_mutex_release(&fslock);
140140
}
141141

142-
/** @addtogroup group_DFS
142+
/** @addtogroup group_device_virtual_file_system
143143
*
144144
*
145145
* @{

documentation/0.doxygen/0.basicdef.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
/**
6-
* @defgroup group_BasicDef Basic Definitions
6+
* @defgroup group_basic_definition Basic Definitions
77
*
88
* @brief Basic data type in RT-Thread RTOS.
99
*

documentation/0.doxygen/1.core.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*/
1515

1616
/**
17-
* @defgroup group_KernelObject Kernel Object Management
17+
* @defgroup group_kernel_object Kernel Object Management
1818
* @brief See @ref section_kernel_object_model
1919
*
2020
* The Kernel object system can access and manage all of the kernel objects.
@@ -34,22 +34,22 @@
3434
*/
3535

3636
/**
37-
* @defgroup group_Thread Thread Management
37+
* @defgroup group_thread_management Thread Management
3838
* @brief See @ref page_thread_management
3939
*/
4040

4141
/**
42-
* @defgroup group_Clock Clock and Timer Management
42+
* @defgroup group_clock_management Clock and Timer Management
4343
* @brief See @ref page_clock_management
4444
*/
4545

4646
/**
47-
* @defgroup group_IPC Inter-Thread Communication
47+
* @defgroup group_thread_comm Inter-Thread Communication
4848
* @brief See @ref page_thread_comm
4949
*/
5050

5151
/**
52-
* @defgroup group_MM Memory Management
52+
* @defgroup group_memory_management Memory Management
5353
* @brief memory management for memory pool and heap memory
5454
*
5555
* RT-Thread operating system supports two types memory management:
@@ -68,7 +68,7 @@
6868
*/
6969

7070
/**
71-
* @defgroup group_Hook Runtime Trace and Record
71+
* @defgroup group_hook Runtime Trace and Record
7272
* @brief the hook function set in runtime
7373
*
7474
* In order to trace and record RT-Thread activity in runtime, a hook mechanism
@@ -83,20 +83,20 @@
8383
*/
8484

8585
/**
86-
* @defgroup group_KernelService Other useful kernel service
86+
* @defgroup group_kernel_service Other useful kernel service
8787
* @brief other useful service in the kernel
8888
*/
8989

9090
/**
91-
* @defgroup group_Error Error Code
91+
* @defgroup group_error Error Code
9292
* @brief error code
9393
*
9494
* The error code is defined to identify which kind of error occurs. When some
9595
* bad things happen, the current thread's errno will be set.
9696
*/
9797

9898
/**
99-
* @defgroup group_SystemInit System Initialization
99+
* @defgroup group_system_init System Initialization
100100
*
101101
* @brief System initialization procedure.
102102
*

documentation/0.doxygen/2.components.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
*/
2121

2222
/**
23-
* @defgroup group_DFS Device Virtual File System
23+
* @defgroup group_device_virtual_file_system Device Virtual File System
2424
*
2525
* @brief DFS is a virtual file system in RT-Thread RTOS.
2626
*
@@ -68,7 +68,7 @@
6868
*/
6969

7070
/**
71-
* @defgroup group_Module Application Module
71+
* @defgroup group_module Application Module
7272
*
7373
* @brief Application Module is a feature let user to execute application in RT-Thread RTOS.
7474
*

documentation/0.doxygen/components/filesystem.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
/**
6-
* @addtogroup group_DFS
6+
* @addtogroup group_device_virtual_file_system
77
* @{
88
*/
99

documentation/0.doxygen/core/ipc.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
/**
6-
* @addtogroup group_IPC
6+
* @addtogroup group_thread_comm
77
* @{
88
*/
99

documentation/0.doxygen/core/systeminit.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
/**
6-
* @ingroup group_SystemInit
6+
* @ingroup group_system_init
77
*
88
* This function will initialize user application.
99
*
@@ -14,6 +14,6 @@
1414
void rt_application_init();
1515

1616
/**
17-
* @ingroup group_SystemInit
17+
* @ingroup group_system_init
1818
*/
1919
void rt_system_heap_init(void* begin_addr, void* end_addr);

documentation/0.doxygen/core/thread.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
/**
6-
* @addtogroup group_Thread
6+
* @addtogroup group_thread_management
77
* @{
88
*/
99

include/rtdef.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ extern "C" {
7575
#endif
7676

7777
/**
78-
* @addtogroup group_BasicDef
78+
* @addtogroup group_basic_definition
7979
*/
8080

8181
/**@{*/
@@ -235,7 +235,7 @@ typedef int (*init_fn_t)(void);
235235
#endif /* RT_KERNEL_REALLOC */
236236

237237
/**
238-
* @ingroup group_BasicDef
238+
* @ingroup group_basic_definition
239239
*
240240
* @def RT_IS_ALIGN(addr, align)
241241
* Return true(1) or false(0).
@@ -246,7 +246,7 @@ typedef int (*init_fn_t)(void);
246246
#define RT_IS_ALIGN(addr, align) ((!(addr & (align - 1))) && (addr != RT_NULL))
247247

248248
/**
249-
* @ingroup group_BasicDef
249+
* @ingroup group_basic_definition
250250
*
251251
* @def RT_ALIGN(size, align)
252252
* Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
@@ -256,7 +256,7 @@ typedef int (*init_fn_t)(void);
256256
#define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1))
257257

258258
/**
259-
* @ingroup group_BasicDef
259+
* @ingroup group_basic_definition
260260
*
261261
* @def RT_ALIGN_DOWN(size, align)
262262
* Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
@@ -266,7 +266,7 @@ typedef int (*init_fn_t)(void);
266266
#define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1))
267267

268268
/**
269-
* @addtogroup group_KernelObject
269+
* @addtogroup group_kernel_object
270270
*/
271271

272272
/**@{*/
@@ -515,7 +515,7 @@ struct rt_object_information
515515
/**@}*/
516516

517517
/**
518-
* @addtogroup group_Clock
518+
* @addtogroup group_clock_management
519519
*/
520520

521521
/**@{*/
@@ -591,7 +591,7 @@ typedef void (*rt_sighandler_t)(int signo);
591591
/**@}*/
592592

593593
/**
594-
* @addtogroup group_Thread
594+
* @addtogroup group_thread_management
595595
*/
596596

597597
/**@{*/
@@ -964,16 +964,16 @@ typedef struct rt_thread *rt_thread_t;
964964
/**@}*/
965965

966966
/**
967-
* @addtogroup group_IPC
967+
* @addtogroup group_thread_comm
968968
*/
969969

970970
/**@{*/
971971

972972
/**
973973
* IPC flags and control command definitions
974974
*/
975-
#define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref group_IPC. */
976-
#define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref group_IPC. */
975+
#define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref group_thread_comm. */
976+
#define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref group_thread_comm. */
977977

978978
#define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */
979979
#define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */
@@ -1134,7 +1134,7 @@ typedef struct rt_messagequeue *rt_mq_t;
11341134
/**@}*/
11351135

11361136
/**
1137-
* @addtogroup group_MM
1137+
* @addtogroup group_memory_management
11381138
*/
11391139

11401140
/**@{*/

0 commit comments

Comments
 (0)