summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-06-24 16:11:28 +0800
committerRbb666 <[email protected]>2025-06-25 14:02:28 +0800
commit8e9872a55456b38d28b0d7d076905be84d0af7a2 (patch)
treee424d87cf44e15581487affff7e5e4d081576921 /documentation
parent29ab5334af46584604c4a758bfcaf456488863d3 (diff)
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]>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/0.doxygen/0.basicdef.h2
-rw-r--r--documentation/0.doxygen/1.core.h18
-rw-r--r--documentation/0.doxygen/2.components.h4
-rw-r--r--documentation/0.doxygen/components/filesystem.h2
-rw-r--r--documentation/0.doxygen/core/ipc.h2
-rw-r--r--documentation/0.doxygen/core/systeminit.h4
-rw-r--r--documentation/0.doxygen/core/thread.h2
7 files changed, 17 insertions, 17 deletions
diff --git a/documentation/0.doxygen/0.basicdef.h b/documentation/0.doxygen/0.basicdef.h
index f779b98594..428cf07fdb 100644
--- a/documentation/0.doxygen/0.basicdef.h
+++ b/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.
*
diff --git a/documentation/0.doxygen/1.core.h b/documentation/0.doxygen/1.core.h
index 4329e9c5ea..5a005dc195 100644
--- a/documentation/0.doxygen/1.core.h
+++ b/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.
*
diff --git a/documentation/0.doxygen/2.components.h b/documentation/0.doxygen/2.components.h
index 131fa3bf11..f16228c8fc 100644
--- a/documentation/0.doxygen/2.components.h
+++ b/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.
*
diff --git a/documentation/0.doxygen/components/filesystem.h b/documentation/0.doxygen/components/filesystem.h
index 9c32edd091..526390e926 100644
--- a/documentation/0.doxygen/components/filesystem.h
+++ b/documentation/0.doxygen/components/filesystem.h
@@ -3,7 +3,7 @@
*/
/**
- * @addtogroup group_DFS
+ * @addtogroup group_device_virtual_file_system
* @{
*/
diff --git a/documentation/0.doxygen/core/ipc.h b/documentation/0.doxygen/core/ipc.h
index dc3225a853..00a498b7b1 100644
--- a/documentation/0.doxygen/core/ipc.h
+++ b/documentation/0.doxygen/core/ipc.h
@@ -3,7 +3,7 @@
*/
/**
- * @addtogroup group_IPC
+ * @addtogroup group_thread_comm
* @{
*/
diff --git a/documentation/0.doxygen/core/systeminit.h b/documentation/0.doxygen/core/systeminit.h
index 3b8f4ad298..6cd116e50f 100644
--- a/documentation/0.doxygen/core/systeminit.h
+++ b/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);
diff --git a/documentation/0.doxygen/core/thread.h b/documentation/0.doxygen/core/thread.h
index 8361d6b0a2..99a05e9c3e 100644
--- a/documentation/0.doxygen/core/thread.h
+++ b/documentation/0.doxygen/core/thread.h
@@ -3,7 +3,7 @@
*/
/**
- * @addtogroup group_Thread
+ * @addtogroup group_thread_management
* @{
*/