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
8 changes: 4 additions & 4 deletions components/dfs/dfs_v1/src/dfs.c
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ static int fd_alloc(struct dfs_fdtable *fdt, int startfd)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
* This function will allocate a file descriptor.
*
* @return -1 on failed or the allocated file descriptor.
Expand Down Expand Up @@ -331,7 +331,7 @@ int fd_new(void)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* This function will return a file descriptor structure according to file
* descriptor.
Expand Down Expand Up @@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* @brief This function will release the file descriptor.
*
Expand Down Expand Up @@ -480,7 +480,7 @@ rt_err_t sys_dup(int oldfd)
#endif /* DFS_USING_POSIX */

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* This function will return whether this file has been opend.
*
Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_file.c
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
}

/**
* @addtogroup group_FileApi
* @addtogroup group_fs_file_api
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_fs.c
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#include "dfs_private.h"

/**
* @addtogroup group_FsApi
* @addtogroup group_fs_api
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_posix.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#endif

/**
* @addtogroup group_FsPosixApi
* @addtogroup group_fs_posix_api
* @{
*/

Expand Down
6 changes: 3 additions & 3 deletions components/dfs/dfs_v2/src/dfs.c
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ void dfs_file_destroy(struct dfs_file *file)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
* This function will allocate a file descriptor.
*
* @return -1 on failed or the allocated file descriptor.
Expand Down Expand Up @@ -291,7 +291,7 @@ void fdt_fd_release(struct dfs_fdtable *fdt, int fd)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* This function will return a file descriptor structure according to file
* descriptor.
Expand Down Expand Up @@ -369,7 +369,7 @@ int fd_new(void)
}

/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* This function will put the file descriptor.
*/
Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v2/src/dfs_fs.c
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ static struct dfs_filesystem_type *file_systems = NULL;
extern rt_list_t _mnt_list;

/**
* @addtogroup group_FsApi
* @addtogroup group_fs_api
*/
/*@{*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v2/src/dfs_posix.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#endif

/**
* @addtogroup group_FsPosixApi
* @addtogroup group_fs_posix_api
* @{
*/

Expand Down
4 changes: 2 additions & 2 deletions components/drivers/audio/dev_audio.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#endif

/**
* @addtogroup group_Audio
* @addtogroup group_drivers_audio
*/

/** @{ */
Expand Down Expand Up @@ -781,4 +781,4 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t
audio->parent.rx_indicate(&audio->parent, len);
}

/** @} group_Audio */
/** @} group_drivers_audio */
14 changes: 7 additions & 7 deletions components/drivers/include/drivers/adc.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

#include <rtthread.h>
/**
* @defgroup group_ADC ADC
* @defgroup group_drivers_adc ADC
* @brief ADC driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -60,7 +60,7 @@


/*!
* @addtogroup group_ADC
* @addtogroup group_drivers_adc
* @{
*/
#define RT_ADC_INTERN_CH_TEMPER (-1)
Expand Down Expand Up @@ -103,7 +103,7 @@ typedef enum
* @param ops device ops
* @param user_data device private data
* @return rt_err_t error code
* @ingroup group_ADC
* @ingroup group_drivers_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);

Expand All @@ -112,7 +112,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 group_ADC
* @ingroup group_drivers_adc
*/
rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);

Expand All @@ -121,7 +121,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 group_ADC
* @ingroup group_drivers_adc
*/
rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);

Expand All @@ -130,7 +130,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 group_ADC
* @ingroup group_drivers_adc
*/
rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);

Expand All @@ -139,7 +139,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 group_ADC
* @ingroup group_drivers_adc
*/
rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);

Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dac.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#define __DAC_H__
#include <rtthread.h>
/**
* @defgroup group_DAC DAC
* @defgroup group_drivers_dac DAC
* @brief DAC driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -61,7 +61,7 @@
*/

/*!
* @addtogroup group_DAC
* @addtogroup group_drivers_dac
* @{
*/
struct rt_dac_device;
Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_audio.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
#include "dev_audio_pipe.h"

/**
* @defgroup group_Audio Audio
* @defgroup group_drivers_audio Audio
* @brief Audio driver API.
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -286,6 +286,6 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt
#define CODEC_VOLUME_MAX (63)
/** @} */ /* End of group_audio_codec_cmd */

/** @} group_Audio */
/** @} group_drivers_audio */

#endif /* __DEV_AUDIO_H__ */
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_can.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ enum CANBAUD
#define RT_CAN_MODE_NOPRIV 0x00

/**
* @defgroup group_CAN_Device CAN Driver
* @defgroup group_drivers_can CAN Driver
* @brief CAN driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -201,7 +201,7 @@ enum CANBAUD


/*!
* @addtogroup group_CAN_Device
* @addtogroup group_drivers_can
* @{
*/
#define CAN_RX_FIFO0 (0x00000000U) /*!< CAN receive FIFO 0 */
Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_i2c.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#include <rtthread.h>
/**
* @defgroup group_I2C I2C
* @defgroup group_drivers_i2c I2C
* @brief I2C driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -170,7 +170,7 @@
*/

/*!
* @addtogroup group_I2C
* @addtogroup group_drivers_i2c
* @{
*/
#ifdef __cplusplus
Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_pin.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#include <rtthread.h>

/**
* @defgroup group_Pin Pin
* @defgroup group_drivers_pin Pin
* @brief Pin driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -69,7 +69,7 @@
*/

/*!
* @addtogroup group_Pin
* @addtogroup group_drivers_pin
* @{
*/
#ifdef __cplusplus
Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_pwm.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#include <rtthread.h>
/**
* @defgroup group_PWM PWM
* @defgroup group_drivers_pwm PWM
* @brief PWM driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -79,7 +79,7 @@
*/

/*!
* @addtogroup group_PWM
* @addtogroup group_drivers_pwm
* @{
*/
#define PWM_CMD_ENABLE (RT_DEVICE_CTRL_BASE(PWM) + 0)
Expand Down
4 changes: 2 additions & 2 deletions components/drivers/include/drivers/dev_rtc.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#include <rtdef.h>
#include <sys/time.h>
/**
* @defgroup group_RTC RTC
* @defgroup group_drivers_rtc RTC
* @brief RTC driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -74,7 +74,7 @@
*/

/*!
* @addtogroup group_RTC
* @addtogroup group_drivers_rtc
* @{
*/
#ifdef __cplusplus
Expand Down
10 changes: 5 additions & 5 deletions components/drivers/include/drivers/dev_serial.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

#include <rtthread.h>
/**
* @defgroup group_Serial Serial
* @defgroup group_drivers_serial Serial
* @brief Serial driver api
* @ingroup group_device_driver
*
Expand Down Expand Up @@ -108,7 +108,7 @@


/*!
* @addtogroup group_Serial
* @addtogroup group_drivers_serial
* @{
*/
#define BAUD_RATE_2400 2400
Expand Down Expand Up @@ -286,7 +286,7 @@ struct rt_uart_ops
* @brief Serial interrupt service routine
* @param serial serial device
* @param event event mask
* @ingroup group_Serial
* @ingroup group_drivers_serial
*/
void rt_hw_serial_isr(struct rt_serial_device *serial, int event);

Expand All @@ -300,7 +300,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 group_Serial
* @ingroup group_drivers_serial
*/
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
const char *name,
Expand All @@ -313,7 +313,7 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
* @param serial serial device
* @return rt_err_t error code
*
* @ingroup group_Serial
* @ingroup group_drivers_serial
*/
rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);

Expand Down
Loading