Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v2/src/dfs.c
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ void dfs_unlock(void)
rt_mutex_release(&fslock);
}

/** @addtogroup group_DFS
/** @addtogroup group_device_virtual_file_system
*
*
* @{
Expand Down
2 changes: 1 addition & 1 deletion documentation/0.doxygen/0.basicdef.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* @defgroup group_BasicDef Basic Definitions
* @defgroup group_basic_definition Basic Definitions
*
* @brief Basic data type in RT-Thread RTOS.
*
Expand Down
18 changes: 9 additions & 9 deletions documentation/0.doxygen/1.core.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -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
Expand All @@ -83,20 +83,20 @@
*/

/**
* @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
* bad things happen, the current thread's errno will be set.
*/

/**
* @defgroup group_SystemInit System Initialization
* @defgroup group_system_init System Initialization
*
* @brief System initialization procedure.
*
Expand Down
4 changes: 2 additions & 2 deletions documentation/0.doxygen/2.components.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion documentation/0.doxygen/components/filesystem.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* @addtogroup group_DFS
* @addtogroup group_device_virtual_file_system
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion documentation/0.doxygen/core/ipc.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* @addtogroup group_IPC
* @addtogroup group_thread_comm
* @{
*/

Expand Down
4 changes: 2 additions & 2 deletions documentation/0.doxygen/core/systeminit.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* @ingroup group_SystemInit
* @ingroup group_system_init
*
* This function will initialize user application.
*
Expand All @@ -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);
2 changes: 1 addition & 1 deletion documentation/0.doxygen/core/thread.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* @addtogroup group_Thread
* @addtogroup group_thread_management
* @{
*/

Expand Down
22 changes: 11 additions & 11 deletions include/rtdef.h
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ extern "C" {
#endif

/**
* @addtogroup group_BasicDef
* @addtogroup group_basic_definition
*/

/**@{*/
Expand Down Expand Up @@ -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).
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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
*/

/**@{*/
Expand Down Expand Up @@ -515,7 +515,7 @@ struct rt_object_information
/**@}*/

/**
* @addtogroup group_Clock
* @addtogroup group_clock_management
*/

/**@{*/
Expand Down Expand Up @@ -591,7 +591,7 @@ typedef void (*rt_sighandler_t)(int signo);
/**@}*/

/**
* @addtogroup group_Thread
* @addtogroup group_thread_management
*/

/**@{*/
Expand Down Expand Up @@ -964,16 +964,16 @@ typedef struct rt_thread *rt_thread_t;
/**@}*/

/**
* @addtogroup group_IPC
* @addtogroup group_thread_comm
*/

/**@{*/

/**
* 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 */
Expand Down Expand Up @@ -1134,7 +1134,7 @@ typedef struct rt_messagequeue *rt_mq_t;
/**@}*/

/**
* @addtogroup group_MM
* @addtogroup group_memory_management
*/

/**@{*/
Expand Down
2 changes: 1 addition & 1 deletion include/rtservice.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ extern "C" {
#endif

/**
* @addtogroup group_KernelService
* @addtogroup group_kernel_service
*/

/**@{*/
Expand Down
14 changes: 7 additions & 7 deletions include/rtthread.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ int entry(void);
#endif

/**
* @addtogroup group_KernelObject
* @addtogroup group_kernel_object
* @{
*/

Expand Down Expand Up @@ -90,7 +90,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object));
/**@}*/

/**
* @addtogroup group_Clock
* @addtogroup group_clock_management
* @{
*/

Expand Down Expand Up @@ -139,7 +139,7 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer));
/**@}*/

/**
* @addtogroup group_Thread
* @addtogroup group_thread_management
* @{
*/

Expand Down Expand Up @@ -262,7 +262,7 @@ int rt_system_signal_init(void);
/**@}*/

/**
* @addtogroup group_MM
* @addtogroup group_memory_management
* @{
*/

Expand Down Expand Up @@ -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
* @{
*/

Expand Down Expand Up @@ -388,7 +388,7 @@ void rt_slab_free(rt_slab_t m, void *ptr);
/**@}*/

/**
* @addtogroup group_IPC
* @addtogroup group_thread_comm
* @{
*/

Expand Down Expand Up @@ -762,7 +762,7 @@ void rt_components_board_init(void);
#endif /* RT_USING_COMPONENTS_INIT */

/**
* @addtogroup group_KernelService
* @addtogroup group_kernel_service
* @{
*/

Expand Down
4 changes: 2 additions & 2 deletions src/clock.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ static volatile rt_atomic_t rt_tick = 0;
static void (*rt_tick_hook)(void);

/**
* @addtogroup group_Hook
* @addtogroup group_hook
*/

/**@{*/
Expand All @@ -56,7 +56,7 @@ void rt_tick_sethook(void (*hook)(void))
#endif /* RT_USING_HOOK */

/**
* @addtogroup group_Clock
* @addtogroup group_clock_management
*/

/**@{*/
Expand Down
2 changes: 1 addition & 1 deletion src/ipc.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/

Expand Down
4 changes: 2 additions & 2 deletions src/irq.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand All @@ -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.
*
Expand Down
4 changes: 2 additions & 2 deletions src/kservice.c
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
#endif

/**
* @addtogroup group_KernelService
* @addtogroup group_kernel_service
* @{
*/

Expand Down Expand Up @@ -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
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion src/mem.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

/**@{*/
Expand Down
Loading
Loading