Переглянути джерело

doxygen: add prefix for groups (#9991)

* doxygen: add prefix for groups

Add "group_" prefix to doxygen group names. This makes
it easier to grep with group name later.

This patch only modifies the groups defined in the pathes
of INPUT of documentation/Doxyfile:

INPUT = . \
        ../src \
        ../include \
        ../components/finsh \
        ../components/drivers/include/drivers \
        ../components/drivers/clk \
        ../components/dfs/dfs_v2/src \
        ../components/dfs/dfs_v2/include

Other groups are not touched.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

* ci: fixed error report when run file_check.py

Such as:
- "please delete extra space at the end of this line."
- "the RT-Thread error code should return negative value. e.g. return
  -RT_ERROR"

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

---------

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Chen Wang 2 місяців тому
батько
коміт
c40b79037c
47 змінених файлів з 233 додано та 233 видалено
  1. 5 5
      components/dfs/dfs_v1/src/dfs.c
  2. 1 1
      components/dfs/dfs_v1/src/dfs_file.c
  3. 1 1
      components/dfs/dfs_v1/src/dfs_fs.c
  4. 1 1
      components/dfs/dfs_v1/src/dfs_posix.c
  5. 4 4
      components/dfs/dfs_v2/src/dfs.c
  6. 1 1
      components/dfs/dfs_v2/src/dfs_fs.c
  7. 1 1
      components/dfs/dfs_v2/src/dfs_posix.c
  8. 4 4
      components/drivers/clk/clk.c
  9. 9 9
      components/drivers/include/drivers/adc.h
  10. 4 4
      components/drivers/include/drivers/blk.h
  11. 4 4
      components/drivers/include/drivers/clk.h
  12. 4 4
      components/drivers/include/drivers/dac.h
  13. 4 4
      components/drivers/include/drivers/dev_can.h
  14. 4 4
      components/drivers/include/drivers/dev_i2c.h
  15. 4 4
      components/drivers/include/drivers/dev_pin.h
  16. 4 4
      components/drivers/include/drivers/dev_pwm.h
  17. 24 24
      components/drivers/include/drivers/dev_rtc.h
  18. 7 7
      components/drivers/include/drivers/dev_serial.h
  19. 36 36
      components/drivers/include/drivers/dev_serial_v2.h
  20. 4 4
      components/drivers/include/drivers/dev_spi.h
  21. 4 4
      components/drivers/include/drivers/dev_touch.h
  22. 5 5
      components/finsh/finsh.h
  23. 8 8
      components/finsh/shell.c
  24. 1 1
      documentation/0.doxygen/basicdef.h
  25. 6 6
      documentation/0.doxygen/filesystem.h
  26. 1 1
      documentation/0.doxygen/finsh.h
  27. 2 2
      documentation/0.doxygen/hardware.h
  28. 12 12
      documentation/0.doxygen/kernel.h
  29. 2 2
      documentation/0.doxygen/mainpage.h
  30. 1 1
      documentation/0.doxygen/module.h
  31. 3 3
      documentation/0.doxygen/systeminit.h
  32. 1 1
      documentation/0.doxygen/thread.h
  33. 18 18
      include/rtdef.h
  34. 1 1
      include/rtservice.h
  35. 14 14
      include/rtthread.h
  36. 2 2
      src/clock.c
  37. 6 6
      src/ipc.c
  38. 3 3
      src/irq.c
  39. 2 2
      src/kservice.c
  40. 1 1
      src/mem.c
  41. 2 2
      src/mempool.c
  42. 2 2
      src/object.c
  43. 2 2
      src/scheduler_mp.c
  44. 2 2
      src/scheduler_up.c
  45. 1 1
      src/slab.c
  46. 1 1
      src/thread.c
  47. 4 4
      src/timer.c

+ 5 - 5
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 DFS
+ * @addtogroup group_DFS
  * @{
  */
 
@@ -297,7 +297,7 @@ static int fd_alloc(struct dfs_fdtable *fdt, int startfd)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  * This function will allocate a file descriptor.
  *
  * @return -1 on failed or the allocated file descriptor.
@@ -331,7 +331,7 @@ int fd_new(void)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * @brief This function will release the file descriptor.
  *
@@ -480,7 +480,7 @@ exit:
 #endif /* DFS_USING_POSIX */
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * This function will return whether this file has been opend.
  *

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

@@ -141,7 +141,7 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
 }
 
 /**
- * @addtogroup FileApi
+ * @addtogroup group_FileApi
  * @{
  */
 

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

@@ -17,7 +17,7 @@
 #include "dfs_private.h"
 
 /**
- * @addtogroup FsApi
+ * @addtogroup group_FsApi
  * @{
  */
 

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

@@ -19,7 +19,7 @@
 #endif
 
 /**
- * @addtogroup FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

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

@@ -139,7 +139,7 @@ void dfs_unlock(void)
     rt_mutex_release(&fslock);
 }
 
-/** @addtogroup DFS
+/** @addtogroup group_DFS
  *
  *
  *  @{
@@ -218,7 +218,7 @@ void dfs_file_destroy(struct dfs_file *file)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  * This function will allocate a file descriptor.
  *
  * @return -1 on failed or the allocated file descriptor.
@@ -291,7 +291,7 @@ void fdt_fd_release(struct dfs_fdtable *fdt, int fd)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -369,7 +369,7 @@ int fd_new(void)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * This function will put the file descriptor.
  */

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

@@ -31,7 +31,7 @@ static struct dfs_filesystem_type *file_systems = NULL;
 extern rt_list_t _mnt_list;
 
 /**
- * @addtogroup FsApi
+ * @addtogroup group_FsApi
  */
 /*@{*/
 

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

@@ -22,7 +22,7 @@
 #endif
 
 /**
- * @addtogroup FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

+ 4 - 4
components/drivers/clk/clk.c

@@ -14,11 +14,11 @@
 #include <rtdevice.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    clk              clk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_clk clk
  * @brief       clk driver api
- * @ingroup     Drivers
- * @addtogroup  clk
+ * @ingroup group_Drivers
+ * @addtogroup  group_clk
  * @{
  */
 

+ 9 - 9
components/drivers/include/drivers/adc.h

@@ -15,8 +15,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    ADC           ADC
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_ADC ADC
  *
  * @brief       ADC driver api
  *
@@ -57,12 +57,12 @@
  *
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 
 /*!
- * @addtogroup ADC
+ * @addtogroup group_ADC
  * @{
  */
 #define RT_ADC_INTERN_CH_TEMPER     (-1)
@@ -105,7 +105,7 @@ typedef enum
  * @param ops device ops
  * @param user_data device private data
  * @return rt_err_t        error code
- * @ingroup  ADC
+ * @ingroup group_ADC
  */
 rt_err_t rt_hw_adc_register(rt_adc_device_t adc,const char *name, const struct rt_adc_ops *ops, const void *user_data);
 
@@ -114,7 +114,7 @@ rt_err_t rt_hw_adc_register(rt_adc_device_t adc,const char *name, const struct r
  * @param dev adc device
  * @param channel adc channel
  * @return rt_uint32_t adc value
- * @ingroup  ADC
+ * @ingroup group_ADC
  */
 rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -123,7 +123,7 @@ rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_err_t error code
- * @ingroup  ADC
+ * @ingroup group_ADC
  */
 rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -132,7 +132,7 @@ rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_err_t error code
- * @ingroup  ADC
+ * @ingroup group_ADC
  */
 rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -141,7 +141,7 @@ rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_int16_t adc resolution
- * @ingroup  ADC
+ * @ingroup group_ADC
  */
 rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);
 

+ 4 - 4
components/drivers/include/drivers/blk.h

@@ -17,11 +17,11 @@
 #include <drivers/classes/block.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    blk              blk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_blk blk
  * @brief       blk driver api
- * @ingroup     Drivers
- * @addtogroup  blk
+ * @ingroup group_Drivers
+ * @addtogroup  group_blk
  * @{
  */
 

+ 4 - 4
components/drivers/include/drivers/clk.h

@@ -18,11 +18,11 @@
 #include <drivers/ofw.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    clk              clk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_clk clk
  * @brief       clk driver api
- * @ingroup     Drivers
- * @addtogroup  clk
+ * @ingroup group_Drivers
+ * @addtogroup  group_clk
  * @{
  */
 

+ 4 - 4
components/drivers/include/drivers/dac.h

@@ -12,8 +12,8 @@
 #define __DAC_H__
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    DAC           DAC
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_DAC DAC
  *
  * @brief       DAC driver api
  *
@@ -60,11 +60,11 @@
  *
  * @endcode
  *
- * @ingroup Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup DAC
+ * @addtogroup group_DAC
  * @{
  */
 struct rt_dac_device;

+ 4 - 4
components/drivers/include/drivers/dev_can.h

@@ -64,8 +64,8 @@ enum CANBAUD
 #define RT_CAN_MODE_NOPRIV              0x00
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    CAN_Device          CAN Driver
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_CAN_Device CAN Driver
  *
  * @brief       CAN driver api
  *
@@ -199,13 +199,13 @@ enum CANBAUD
  * MSH_CMD_EXPORT(can_sample, can device sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  *
  */
 
 
 /*!
- * @addtogroup CAN_Device
+ * @addtogroup group_CAN_Device
  * @{
  */
 #define CAN_RX_FIFO0                (0x00000000U)  /*!< CAN receive FIFO 0 */

+ 4 - 4
components/drivers/include/drivers/dev_i2c.h

@@ -14,8 +14,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    I2C              I2C
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_I2C I2C
  *
  * @brief       I2C driver api
  *
@@ -169,11 +169,11 @@
  * MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup I2C
+ * @addtogroup group_I2C
  * @{
  */
 #ifdef __cplusplus

+ 4 - 4
components/drivers/include/drivers/dev_pin.h

@@ -15,8 +15,8 @@
 #include <rtthread.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    Pin              Pin
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_Pin Pin
  *
  * @brief       Pin driver api
  *
@@ -68,11 +68,11 @@
  * MSH_CMD_EXPORT(pin_beep_sample, pin beep sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup Pin
+ * @addtogroup group_Pin
  * @{
  */
 #ifdef __cplusplus

+ 4 - 4
components/drivers/include/drivers/dev_pwm.h

@@ -14,8 +14,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    PWM              PWM
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_PWM PWM
  *
  * @brief       PWM driver api
  *
@@ -78,11 +78,11 @@
  * MSH_CMD_EXPORT(pwm_led_sample, pwm sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup PWM
+ * @addtogroup group_PWM
  * @{
  */
 #define PWM_CMD_ENABLE      (RT_DEVICE_CTRL_BASE(PWM) + 0)

+ 24 - 24
components/drivers/include/drivers/dev_rtc.h

@@ -17,67 +17,67 @@
 #include <rtdef.h>
 #include <sys/time.h>
 /**
- * @addtogroup  Drivers    RTTHREAD Driver
- * @defgroup    RTC        RTC 
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_RTC RTC
  *
  * @brief       RTC driver api
- * 
+ *
  * <b>Example</b>
  * @code {.c}
- * 
+ *
  * #include <rtthread.h>
  * #include <rtdevice.h>
- * 
+ *
  * #define RTC_NAME       "rtc"
- * 
+ *
  * static int rtc_sample(int argc, char *argv[])
  * {
  *     rt_err_t ret = RT_EOK;
  *     time_t now;
  *     rt_device_t device = RT_NULL;
- * 
+ *
  *     device = rt_device_find(RTC_NAME);
  *     if (!device)
  *     {
  *       LOG_E("find %s failed!", RTC_NAME);
- *       return RT_ERROR;
+ *       return -RT_ERROR;
  *     }
- * 
+ *
  *     if(rt_device_open(device, 0) != RT_EOK)
  *     {
  *       LOG_E("open %s failed!", RTC_NAME);
- *       return RT_ERROR;
+ *       return -RT_ERROR;
  *     }
- * 
+ *
  *     ret = set_date(2018, 12, 3);
  *     if (ret != RT_EOK)
  *     {
  *         rt_kprintf("set RTC date failed\n");
  *         return ret;
  *     }
- * 
+ *
  *     ret = set_time(11, 15, 50);
  *     if (ret != RT_EOK)
  *     {
  *         rt_kprintf("set RTC time failed\n");
  *         return ret;
  *     }
- * 
+ *
  *     rt_thread_mdelay(3000);
- * 
+ *
  *     now = time(RT_NULL);
  *     rt_kprintf("%s\n", ctime(&now));
- * 
+ *
  *     return ret;
  * }
  * MSH_CMD_EXPORT(rtc_sample, rtc sample);
  * @endcode
- * 
- * @ingroup     Drivers
+ *
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup RTC
+ * @addtogroup group_RTC
  * @{
  */
 #ifdef __cplusplus
@@ -132,7 +132,7 @@ typedef struct rt_rtc_device
 
 /**
  * @brief Register a RTC device
- * 
+ *
  * @param rtc RTC device
  * @param name RTC device name
  * @param flag RTC device flag
@@ -145,8 +145,8 @@ rt_err_t rt_hw_rtc_register(rt_rtc_dev_t  *rtc,
                             void          *data);
 
 /**
- * @brief set date 
- * 
+ * @brief set date
+ *
  * @param year year
  * @param month month
  * @param day day
@@ -156,7 +156,7 @@ rt_err_t set_date(rt_uint32_t year, rt_uint32_t month, rt_uint32_t day);
 
 /**
  * @brief set time
- * 
+ *
  * @param hour hour
  * @param minute minute
  * @param second second
@@ -166,7 +166,7 @@ rt_err_t set_time(rt_uint32_t hour, rt_uint32_t minute, rt_uint32_t second);
 
 /**
  * @brief set timestamp
- * 
+ *
  * @param timestamp A pointer to time
  * @return rt_err_t error code
  */
@@ -174,7 +174,7 @@ rt_err_t set_timestamp(time_t timestamp);
 
 /**
  * @brief get timestamp
- * 
+ *
  * @param timestamp A secondary pointer to time
  * @return rt_err_t error code
  */

+ 7 - 7
components/drivers/include/drivers/dev_serial.h

@@ -16,8 +16,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    Serial           Serial
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_Serial Serial
  *
  * @brief       Serial driver api
  *
@@ -106,12 +106,12 @@
  * MSH_CMD_EXPORT(uart_sample, uart device sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 
 /*!
- * @addtogroup Serial
+ * @addtogroup group_Serial
  * @{
  */
 #define BAUD_RATE_2400                  2400
@@ -289,7 +289,7 @@ struct rt_uart_ops
  * @brief Serial interrupt service routine
  * @param serial    serial device
  * @param event     event mask
- * @ingroup  Serial
+ * @ingroup group_Serial
  */
 void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
 
@@ -303,7 +303,7 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
  * @return rt_err_t        error code
  * @note This function will register a serial device to system device list,
  *       and add a device object to system object list.
- * @ingroup  Serial
+ * @ingroup group_Serial
  */
 rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
                                const char              *name,
@@ -316,7 +316,7 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
  * @param serial    serial device
  * @return rt_err_t error code
  *
- * @ingroup  Serial
+ * @ingroup group_Serial
  */
 rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
 

+ 36 - 36
components/drivers/include/drivers/dev_serial_v2.h

@@ -15,19 +15,19 @@
 
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    Serial_v2       Serial v2
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_Serial_v2 Serial v2
  *
  * @brief       Serial v2 driver api
- * 
+ *
  * <b>Example</b>
  * @code {.c}
- * 
+ *
  * #include <rtthread.h>
  * #include <rtdevice.h>
- * 
- * #define SAMPLE_UART_NAME       "uart1"      
- * 
+ *
+ * #define SAMPLE_UART_NAME       "uart1"
+ *
  * struct rx_msg
  * {
  *     rt_device_t dev;
@@ -35,14 +35,14 @@
  * };
  * static rt_device_t serial;
  * static struct rt_messagequeue rx_mq;
- * 
+ *
  * static rt_err_t uart_input(rt_device_t dev, rt_size_t size)
  * {
  *     struct rx_msg msg;
  *     rt_err_t result;
  *     msg.dev = dev;
  *     msg.size = size;
- * 
+ *
  *     result = rt_mq_send(&rx_mq, &msg, sizeof(msg));
  *     if (result == -RT_EFULL)
  *     {
@@ -50,14 +50,14 @@
  *     }
  *     return result;
  * }
- * 
+ *
  * static void serial_thread_entry(void *parameter)
  * {
  *     struct rx_msg msg;
  *     rt_err_t result;
  *     rt_uint32_t rx_length;
  *     static char rx_buffer[BSP_UART1_RX_BUFSIZE + 1];
- * 
+ *
  *     while (1)
  *     {
  *         rt_memset(&msg, 0, sizeof(msg));
@@ -71,14 +71,14 @@
  *         }
  *     }
  * }
- * 
+ *
  * static int uart_dma_sample(int argc, char *argv[])
  * {
  *     rt_err_t ret = RT_EOK;
  *     char uart_name[RT_NAME_MAX];
  *     static char msg_pool[256];
  *     char str[] = "hello RT-Thread!\r\n";
- * 
+ *
  *     if (argc == 2)
  *     {
  *         rt_strncpy(uart_name, argv[1], RT_NAME_MAX);
@@ -87,24 +87,24 @@
  *     {
  *         rt_strncpy(uart_name, SAMPLE_UART_NAME, RT_NAME_MAX);
  *     }
- * 
+ *
  *     serial = rt_device_find(uart_name);
  *     if (!serial)
  *     {
  *         rt_kprintf("find %s failed!\n", uart_name);
- *         return RT_ERROR;
+ *         return -RT_ERROR;
  *     }
- * 
+ *
  *     rt_mq_init(&rx_mq, "rx_mq",
- *                msg_pool,                 
- *                sizeof(struct rx_msg),    
- *                sizeof(msg_pool),         
- *                RT_IPC_FLAG_FIFO);       
- * 
+ *                msg_pool,
+ *                sizeof(struct rx_msg),
+ *                sizeof(msg_pool),
+ *                RT_IPC_FLAG_FIFO);
+ *
  *     rt_device_open(serial, RT_DEVICE_FLAG_RX_NON_BLOCKING | RT_DEVICE_FLAG_TX_BLOCKING);
  *     rt_device_set_rx_indicate(serial, uart_input);
  *     rt_device_write(serial, 0, str, (sizeof(str) - 1));
- * 
+ *
  *     rt_thread_t thread = rt_thread_create("serial", serial_thread_entry, RT_NULL, 1024, 25, 10);
  *     if (thread != RT_NULL)
  *     {
@@ -114,18 +114,18 @@
  *     {
  *         ret = RT_ERROR;
  *     }
- * 
+ *
  *     return ret;
  * }
  * MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample);
  * @endcode
- * 
- * @ingroup     Drivers
+ *
+ * @ingroup group_Drivers
  */
 
 
 /*!
- * @addtogroup Serial_v2
+ * @addtogroup group_Serial_v2
  * @{
  */
 
@@ -221,7 +221,7 @@
 
 /**
  * @brief Serial receive indicate hook function type
- * 
+ *
  */
 typedef void (*rt_hw_serial_rxind_hookproto_t)(rt_device_t dev, rt_size_t size);
 RT_OBJECT_HOOKLIST_DECLARE(rt_hw_serial_rxind_hookproto_t, rt_hw_serial_rxind);
@@ -258,7 +258,7 @@ struct rt_serial_rx_fifo
 
 /**
  * @brief Serial Transmit FIFO mode
- * 
+ *
  */
 struct rt_serial_tx_fifo
 {
@@ -276,7 +276,7 @@ struct rt_serial_tx_fifo
 
 /**
  * @brief     serial device structure
- * 
+ *
  */
 struct rt_serial_device
 {
@@ -293,7 +293,7 @@ struct rt_serial_device
 
 /**
  * @brief uart device operations
- * 
+ *
  */
 struct rt_uart_ops
 {
@@ -317,14 +317,14 @@ struct rt_uart_ops
  * @brief Serial interrupt service routine
  * @param serial    serial device
  * @param event     event mask
- * @ingroup  Serial_v2
+ * @ingroup group_Serial_v2
  */
 void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
 
 
 /**
  * @brief Register a serial device to device list
- * 
+ *
  * @param serial    serial device
  * @param name      device name
  * @param flag      device flag
@@ -332,7 +332,7 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
  * @return rt_err_t        error code
  * @note This function will register a serial device to system device list,
  *       and add a device object to system object list.
- * @ingroup  Serial_v2
+ * @ingroup group_Serial_v2
  */
 rt_err_t rt_hw_serial_register(struct rt_serial_device      *serial,
                                const  char                  *name,
@@ -341,11 +341,11 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device      *serial,
 
 /**
  * @brief     register a serial device to system device list and add a device object to system object list
- * 
+ *
  * @param serial    serial device
  * @return rt_err_t error code
- * 
- * @ingroup  Serial_v2
+ *
+ * @ingroup group_Serial_v2
  */
 rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
 

+ 4 - 4
components/drivers/include/drivers/dev_spi.h

@@ -19,8 +19,8 @@
 #include <drivers/core/driver.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    SPI              SPI
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_SPI SPI
  *
  * @brief       SPI driver api
  *
@@ -85,11 +85,11 @@
  * MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup SPI
+ * @addtogroup group_SPI
  * @{
  */
 #ifdef __cplusplus

+ 4 - 4
components/drivers/include/drivers/dev_touch.h

@@ -14,8 +14,8 @@
 #include <rtthread.h>
 #include "dev_pin.h"
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    Touch            Touch
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_Touch Touch
  *
  * @brief       Touch driver api
  *
@@ -112,11 +112,11 @@
  * MSH_CMD_EXPORT(gt9147_sample, gt9147 sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup Touch
+ * @addtogroup group_Touch
  * @{
  */
 #ifdef __cplusplus

+ 5 - 5
components/finsh/finsh.h

@@ -109,7 +109,7 @@ typedef long (*syscall_func)(void);
 
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This macro exports a system function to finsh shell.
  *
@@ -119,7 +119,7 @@ typedef long (*syscall_func)(void);
 #define FINSH_FUNCTION_EXPORT(name, desc)
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This macro exports a system function with an alias name to finsh shell.
  *
@@ -130,7 +130,7 @@ typedef long (*syscall_func)(void);
 #define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This macro exports a command to module shell.
  *
@@ -144,7 +144,7 @@ typedef long (*syscall_func)(void);
         _MSH_FUNCTION_CMD2)(__VA_ARGS__)
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This macro exports a command with alias to module shell.
  *
@@ -155,7 +155,7 @@ typedef long (*syscall_func)(void);
  * @code
  *      #define MSH_CMD_EXPORT_ALIAS(command, alias, desc) or
  *      #define MSH_CMD_EXPORT_ALIAS(command, alias, desc, opt)
- * @endcode 
+ * @endcode
  */
 #define MSH_CMD_EXPORT_ALIAS(...)                                           \
     __MSH_GET_EXPORT_MACRO(__VA_ARGS__, _MSH_FUNCTION_EXPORT_CMD3_OPT,      \

+ 8 - 8
components/finsh/shell.c

@@ -127,7 +127,7 @@ const char *finsh_get_prompt(void)
 }
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function get the prompt mode of finsh shell.
  *
@@ -140,7 +140,7 @@ rt_uint32_t finsh_get_prompt_mode(void)
 }
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function set the prompt mode of finsh shell.
  *
@@ -210,7 +210,7 @@ static rt_err_t finsh_rx_ind(rt_device_t dev, rt_size_t size)
 }
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function sets the input device of finsh shell.
  *
@@ -251,7 +251,7 @@ void finsh_set_device(const char *device_name)
 }
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function returns current finsh shell input device.
  *
@@ -265,7 +265,7 @@ const char *finsh_get_device()
 #endif /* !defined(RT_USING_POSIX_STDIO) && defined(RT_USING_DEVICE) */
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function set the echo mode of finsh shell.
  *
@@ -280,7 +280,7 @@ void finsh_set_echo(rt_uint32_t echo)
 }
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function gets the echo mode of finsh shell.
  *
@@ -461,7 +461,7 @@ static void shell_push_history(struct finsh_shell *shell)
 static void (*_finsh_thread_entry_hook)(void);
 
 /**
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * @brief This function set a hook function at the entry of finsh thread
  *
@@ -755,7 +755,7 @@ __declspec(allocate("FSymTab$z")) const struct finsh_syscall __fsym_end =
 #endif
 
 /*
- * @ingroup finsh
+ * @ingroup group_finsh
  *
  * This function will initialize finsh shell
  */

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

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

+ 6 - 6
documentation/0.doxygen/filesystem.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup DFS Device Virtual File System
+ * @defgroup group_DFS Device Virtual File System
  *
  * @brief DFS is a virtual file system in RT-Thread RTOS.
  *
@@ -20,25 +20,25 @@
  */
 
 /**
- * @addtogroup DFS
+ * @addtogroup group_DFS
  * @{
  */
 
 /**
- * @defgroup Fd File Descriptor
+ * @defgroup group_Fd File Descriptor
  *
  */
 
 /**
- * @defgroup FsApi File System API
+ * @defgroup group_FsApi File System API
  */
 
 /**
- * @defgroup FileApi File API
+ * @defgroup group_FileApi File API
  */
 
 /**
- * @defgroup FsPosixApi File POSIX API
+ * @defgroup group_FsPosixApi File POSIX API
  */
 
 /**@}*/

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

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup finsh finsh shell
+ * @defgroup group_finsh finsh shell
  *
  * @brief finsh shell is a user command shell in RT-Thread RTOS.
  *

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

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup bsp Hardware Related Package
+ * @defgroup group_bsp Hardware Related Package
  *
  * @brief Hardware Related Package includes board support package(BSP) and CSP(Chip
  * Support Package).
@@ -18,7 +18,7 @@
  */
 
 /**
- * @addtogroup bsp
+ * @addtogroup group_bsp
  * @{
  */
 

+ 12 - 12
documentation/0.doxygen/kernel.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup Kernel RT-Thread Kernel API
+ * @defgroup group_Kernel RT-Thread Kernel API
  *
  * The Kernel APIs are the core APIs of RT-Thread, which supports the following
  * features:
@@ -15,12 +15,12 @@
  */
 
 /**
- * @addtogroup Kernel
+ * @addtogroup group_Kernel
  * @{
  */
 
 /**
- * @defgroup Thread Thread Management
+ * @defgroup group_Thread Thread Management
  * @brief the thread management
  *
  * RT-Thread operating system supports multitask systems, which are based on thread
@@ -40,7 +40,7 @@
  */
 
 /**
- * @defgroup Clock Clock and Timer Management
+ * @defgroup group_Clock Clock and Timer Management
  * @brief clock and system timer management
  *
  * RT-Thread uses clock tick to implement shared time-slice scheduling.
@@ -50,7 +50,7 @@
  */
 
 /**
- * @defgroup KernelObject Kernel Object Management
+ * @defgroup group_KernelObject Kernel Object Management
  * @brief kernel object management
  *
  * The Kernel object system can access and manage all of the kernel objects.
@@ -70,7 +70,7 @@
  */
 
 /**
- * @defgroup IPC Inter-Thread Communication
+ * @defgroup group_IPC Inter-Thread Communication
  * @brief inter-thread communication
  *
  * RT-Thread operating system supports the traditional semaphore and mutex.
@@ -96,7 +96,7 @@
  */
 
 /**
- * @defgroup Signal Signal
+ * @defgroup group_Signal Signal
  * @brief signal is used for thread kill etc.
  *
  * A signal (also known as a soft interrupt signal), from a software perspective,
@@ -105,7 +105,7 @@
  */
 
 /**
- * @defgroup MM Memory Management
+ * @defgroup group_MM Memory Management
  * @brief memory management for memory pool and heap memory
  *
  * RT-Thread operating system supports two types memory management:
@@ -124,7 +124,7 @@
  */
 
 /**
- * @defgroup Device Device System
+ * @defgroup group_Device Device System
  * @brief device I/O subsystem
  *
  * The Device System is designed as simple and minimum layer to help communication between
@@ -139,7 +139,7 @@
  */
 
 /**
- * @defgroup 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
@@ -154,12 +154,12 @@
  */
 
 /**
- * @defgroup KernelService Other useful kernel service
+ * @defgroup group_KernelService Other useful kernel service
  * @brief other useful service in the kernel
  */
 
 /**
- * @defgroup 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

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

@@ -38,12 +38,12 @@
  * - Memory management, memory pool and dynamic heap memory management
  * - Asynchronous timer
  *
- * For more details, please refer to @ref Kernel
+ * For more details, please refer to @ref group_Kernel
  *
  * @section system_init System Initialization
  *
  * Once RT-Thread operating system starts up, the facility in system must be initialized
  * firstly.
  *
- * For more details, please refer to @ref SystemInit
+ * For more details, please refer to @ref group_SystemInit
  */

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

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup Module Application Module
+ * @defgroup group_Module Application Module
  *
  * @brief Application Module is a feature let user to execute application in RT-Thread RTOS.
  *

+ 3 - 3
documentation/0.doxygen/systeminit.h

@@ -3,7 +3,7 @@
  */
 
 /**
- * @defgroup SystemInit System Initialization
+ * @defgroup group_SystemInit System Initialization
  *
  * @brief System initialization procedure.
  *
@@ -47,7 +47,7 @@
  */
 
 /**
- * @ingroup SystemInit
+ * @ingroup group_SystemInit
  *
  * This function will initialize user application.
  *
@@ -58,6 +58,6 @@
 void rt_application_init();
 
 /**
- * @ingroup SystemInit
+ * @ingroup group_SystemInit
  */
 void rt_system_heap_init(void* begin_addr, void* end_addr);

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

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

+ 18 - 18
include/rtdef.h

@@ -75,7 +75,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup BasicDef
+ * @addtogroup group_BasicDef
  */
 
 /**@{*/
@@ -235,7 +235,7 @@ typedef int (*init_fn_t)(void);
 #endif /* RT_KERNEL_REALLOC */
 
 /**
- * @ingroup BasicDef
+ * @ingroup group_BasicDef
  *
  * @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 BasicDef
+ * @ingroup group_BasicDef
  *
  * @def RT_ALIGN(size, align)
  * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
@@ -255,7 +255,7 @@ typedef int (*init_fn_t)(void);
 #define RT_ALIGN(size, align)           (((size) + (align) - 1) & ~((align) - 1))
 
 /**
- * @ingroup BasicDef
+ * @ingroup group_BasicDef
  *
  * @def RT_ALIGN_DOWN(size, align)
  * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
@@ -264,7 +264,7 @@ typedef int (*init_fn_t)(void);
 #define RT_ALIGN_DOWN(size, align)      ((size) & ~((align) - 1))
 
 /**
- * @addtogroup KernelObject
+ * @addtogroup group_KernelObject
  */
 
 /**@{*/
@@ -513,7 +513,7 @@ struct rt_object_information
 /**@}*/
 
 /**
- * @addtogroup Clock
+ * @addtogroup group_Clock
  */
 
 /**@{*/
@@ -576,7 +576,7 @@ typedef struct rt_timer *rt_timer_t;
 /**@}*/
 
 /**
- * @addtogroup Signal
+ * @addtogroup group_Signal
  */
 /**@{*/
 
@@ -589,7 +589,7 @@ typedef void (*rt_sighandler_t)(int signo);
 /**@}*/
 
 /**
- * @addtogroup Thread
+ * @addtogroup group_Thread
  */
 
 /**@{*/
@@ -961,7 +961,7 @@ typedef struct rt_thread *rt_thread_t;
 /**@}*/
 
 /**
- * @addtogroup IPC
+ * @addtogroup group_IPC
  */
 
 /**@{*/
@@ -969,8 +969,8 @@ typedef struct rt_thread *rt_thread_t;
 /**
  * IPC flags and control command definitions
  */
-#define RT_IPC_FLAG_FIFO                0x00            /**< FIFOed IPC. @ref IPC. */
-#define RT_IPC_FLAG_PRIO                0x01            /**< PRIOed IPC. @ref IPC. */
+#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_CMD_UNKNOWN              0x00            /**< unknown IPC command */
 #define RT_IPC_CMD_RESET                0x01            /**< reset IPC object */
@@ -991,7 +991,7 @@ struct rt_ipc_object
 };
 
 /**
- * @addtogroup semaphore
+ * @addtogroup group_semaphore Semaphore
  * @{
  */
 
@@ -1013,7 +1013,7 @@ typedef struct rt_semaphore *rt_sem_t;
 /**@}*/
 
 /**
- * @addtogroup mutex
+ * @addtogroup group_mutex Mutex
  * @{
  */
 
@@ -1040,7 +1040,7 @@ typedef struct rt_mutex *rt_mutex_t;
 /**@}*/
 
 /**
- * @addtogroup event
+ * @addtogroup group_event Event
  * @{
  */
 
@@ -1068,7 +1068,7 @@ typedef struct rt_event *rt_event_t;
 /**@}*/
 
 /**
- * @addtogroup mailbox
+ * @addtogroup group_mailbox MailBox
  * @{
  */
 
@@ -1097,7 +1097,7 @@ typedef struct rt_mailbox *rt_mailbox_t;
 /**@}*/
 
 /**
- * @addtogroup messagequeue
+ * @addtogroup group_messagequeue Message Queue
  * @{
  */
 
@@ -1131,7 +1131,7 @@ typedef struct rt_messagequeue *rt_mq_t;
 /**@}*/
 
 /**
- * @addtogroup MM
+ * @addtogroup group_MM
  */
 
 /**@{*/
@@ -1234,7 +1234,7 @@ typedef struct rt_mempool *rt_mp_t;
 
 #ifdef RT_USING_DEVICE
 /**
- * @addtogroup Device
+ * @addtogroup group_Device
  */
 
 /**@{*/

+ 1 - 1
include/rtservice.h

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

+ 14 - 14
include/rtthread.h

@@ -50,7 +50,7 @@ int entry(void);
 #endif
 
 /**
- * @addtogroup KernelObject
+ * @addtogroup group_KernelObject
  * @{
  */
 
@@ -90,7 +90,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object));
 /**@}*/
 
 /**
- * @addtogroup Clock
+ * @addtogroup group_Clock
  * @{
  */
 
@@ -138,7 +138,7 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer));
 /**@}*/
 
 /**
- * @addtogroup Thread
+ * @addtogroup group_Thread
  * @{
  */
 
@@ -247,7 +247,7 @@ void rt_scheduler_ipi_handler(int vector, void *param);
 /**@}*/
 
 /**
- * @addtogroup Signal
+ * @addtogroup group_Signal
  * @{
  */
 #ifdef RT_USING_SIGNALS
@@ -260,7 +260,7 @@ int rt_system_signal_init(void);
 /**@}*/
 
 /**
- * @addtogroup MM
+ * @addtogroup group_MM
  * @{
  */
 
@@ -316,7 +316,7 @@ void rt_page_free(void *addr, rt_size_t npages);
 #endif /* defined(RT_USING_SLAB) && defined(RT_USING_SLAB_AS_HEAP) */
 
 /**
- * @ingroup Hook
+ * @ingroup group_Hook
  * @{
  */
 
@@ -386,7 +386,7 @@ void rt_slab_free(rt_slab_t m, void *ptr);
 /**@}*/
 
 /**
- * @addtogroup IPC
+ * @addtogroup group_IPC
  * @{
  */
 
@@ -411,7 +411,7 @@ rt_err_t rt_thread_suspend_to_list(rt_thread_t thread, rt_list_t *susp_list, int
 rt_err_t rt_susp_list_enqueue(rt_list_t *susp_list, rt_thread_t thread, int ipc_flags);
 
 /**
- * @addtogroup semaphore
+ * @addtogroup group_semaphore Semaphore
  * @{
  */
 
@@ -440,7 +440,7 @@ rt_err_t rt_sem_control(rt_sem_t sem, int cmd, void *arg);
 /**@}*/
 
 /**
- * @addtogroup mutex
+ * @addtogroup group_mutex Mutex
  * @{
  */
 
@@ -479,7 +479,7 @@ rt_inline rt_ubase_t rt_mutex_get_hold(rt_mutex_t mutex)
 /**@}*/
 
 /**
- * @addtogroup event
+ * @addtogroup group_event Event
  * @{
  */
 
@@ -516,7 +516,7 @@ rt_err_t rt_event_control(rt_event_t event, int cmd, void *arg);
 /**@}*/
 
 /**
- * @addtogroup mailbox
+ * @addtogroup group_mailbox MailBox
  * @{
  */
 
@@ -557,7 +557,7 @@ rt_err_t rt_mb_control(rt_mailbox_t mb, int cmd, void *arg);
 /**@}*/
 
 /**
- * @addtogroup messagequeue
+ * @addtogroup group_messagequeue Message Queue
  * @{
  */
 #ifdef RT_USING_MESSAGEQUEUE
@@ -661,7 +661,7 @@ void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level);
 
 #ifdef RT_USING_DEVICE
 /**
- * @addtogroup Device
+ * @addtogroup group_Device
  * @{
  */
 
@@ -760,7 +760,7 @@ void rt_components_board_init(void);
 #endif /* RT_USING_COMPONENTS_INIT */
 
 /**
- * @addtogroup KernelService
+ * @addtogroup group_KernelService
  * @{
  */
 

+ 2 - 2
src/clock.c

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

+ 6 - 6
src/ipc.c

@@ -63,7 +63,7 @@ extern void (*rt_object_put_hook)(struct rt_object *object);
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup IPC
+ * @addtogroup group_IPC
  * @{
  */
 
@@ -314,7 +314,7 @@ void rt_susp_list_print(rt_list_t *list)
 
 #ifdef RT_USING_SEMAPHORE
 /**
- * @addtogroup semaphore
+ * @addtogroup group_semaphore Semaphore
  * @{
  */
 
@@ -976,7 +976,7 @@ static void _mutex_before_delete_detach(rt_mutex_t mutex)
 }
 
 /**
- * @addtogroup mutex
+ * @addtogroup group_mutex Mutex
  * @{
  */
 
@@ -1745,7 +1745,7 @@ RTM_EXPORT(rt_mutex_control);
 
 #ifdef RT_USING_EVENT
 /**
- * @addtogroup event
+ * @addtogroup group_event Event
  * @{
  */
 
@@ -2298,7 +2298,7 @@ RTM_EXPORT(rt_event_control);
 
 #ifdef RT_USING_MAILBOX
 /**
- * @addtogroup mailbox
+ * @addtogroup group_mailbox MailBox
  * @{
  */
 
@@ -3043,7 +3043,7 @@ RTM_EXPORT(rt_mb_control);
 
 #ifdef RT_USING_MESSAGEQUEUE
 /**
- * @addtogroup messagequeue
+ * @addtogroup group_messagequeue Message Queue
  * @{
  */
 

+ 3 - 3
src/irq.c

@@ -30,7 +30,7 @@ static void (*rt_interrupt_enter_hook)(void);
 static void (*rt_interrupt_leave_hook)(void);
 
 /**
- * @ingroup 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 Hook
+ * @ingroup group_Hook
  *
  * @brief This function set a hook function when the system exit a interrupt.
  *
@@ -59,7 +59,7 @@ void rt_interrupt_leave_sethook(void (*hook)(void))
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup Kernel
+ * @addtogroup group_Kernel
  */
 
 /**@{*/

+ 2 - 2
src/kservice.c

@@ -54,7 +54,7 @@
 #endif
 
 /**
- * @addtogroup KernelService
+ * @addtogroup group_KernelService
  * @{
  */
 
@@ -589,7 +589,7 @@ static void (*rt_realloc_exit_hook)(void **ptr, rt_size_t size);
 static void (*rt_free_hook)(void **ptr);
 
 /**
- * @ingroup 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 MM
+ * @addtogroup group_MM
  */
 
 /**@{*/

+ 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 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 MM
+ * @addtogroup group_MM
  */
 
 /**@{*/

+ 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 Hook
+ * @addtogroup group_Hook
  */
 
 /**@{*/
@@ -231,7 +231,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
 #endif /* RT_USING_HOOK */
 
 /**
- * @addtogroup KernelObject
+ * @addtogroup group_KernelObject
  */
 
 /**@{*/

+ 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 Hook
+ * @addtogroup group_Hook
  */
 
 /**@{*/
@@ -495,7 +495,7 @@ void rt_system_scheduler_start(void)
 }
 
 /**
- * @addtogroup Thread
+ * @addtogroup group_Thread
  * @cond
  */
 

+ 2 - 2
src/scheduler_up.c

@@ -55,7 +55,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 Hook
+ * @addtogroup group_Hook
  */
 
 /**@{*/
@@ -187,7 +187,7 @@ void rt_system_scheduler_start(void)
 }
 
 /**
- * @addtogroup Thread
+ * @addtogroup group_Thread
  * @cond
  */
 

+ 1 - 1
src/slab.c

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

+ 1 - 1
src/thread.c

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

+ 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 Hook
+ * @addtogroup group_Hook
  */
 
 /**@{*/
@@ -240,7 +240,7 @@ void rt_timer_dump(rt_list_t timer_heads[])
 #endif /* (DBG_LVL == DBG_LOG) */
 
 /**
- * @addtogroup Clock
+ * @addtogroup group_Clock
  */
 
 /**@{*/
@@ -816,7 +816,7 @@ static void _timer_thread_entry(void *parameter)
 #endif /* RT_USING_TIMER_SOFT */
 
 /**
- * @ingroup SystemInit
+ * @ingroup group_SystemInit
  *
  * @brief This function will initialize system timer
  */
@@ -835,7 +835,7 @@ void rt_system_timer_init(void)
 }
 
 /**
- * @ingroup SystemInit
+ * @ingroup group_SystemInit
  *
  * @brief This function will initialize system timer thread
  */