Просмотр исходного кода

fix:修改注释语法为doxgen语法

wl 2 лет назад
Родитель
Сommit
dd7dbeb319
1 измененных файлов с 14 добавлено и 10 удалено
  1. 14 10
      luat/include/luat_adc.h

+ 14 - 10
luat/include/luat_adc.h

@@ -7,7 +7,10 @@
 #define Luat_ADC_H
 
 #include "luat_base.h"
-
+/**
+ * @defgroup luatos_device_adc ADC接口
+ * @{
+*/
 #define LUAT_ADC_CH_CPU		(-1)
 #define LUAT_ADC_CH_VBAT	(-2)
 
@@ -24,6 +27,7 @@ typedef enum LUAT_ADC_CTRL_CMD
 	LUAT_ADC_SET_GLOBAL_RANGE,/**< 量程 */
 }LUAT_ADC_CTRL_CMD_E;
 
+/// @brief ADC量程
 typedef enum LUAT_ADC_RANGE
 {
 	LUAT_ADC_AIO_RANGE_1_2,
@@ -60,40 +64,40 @@ typedef union luat_adc_ctrl_param
 	void *userdata;/**< 预留 */
 } luat_adc_ctrl_param_t;
 
-/******************************************************************************
+/**
  * luat_adc_open
  * Description: 打开一个adc通道
  * @param pin[in] adc通道的序号
  * @param args[in] 保留用,传NULL
  * @return 0 成功, 其他值为失败
-******************************************************************************/
+ */
 int luat_adc_open(int pin, void* args);
 
-/******************************************************************************
+/**
  * luat_adc_read
  * Description: 读取adc通道的值
  * @param pin[in] adc通道的序号
  * @param val[out] adc通道的原始值
  * @param val2[out] adc通道的计算值,与具体通道有关
  * @return 0 成功, 其他值为失败
-******************************************************************************/
+ */
 int luat_adc_read(int pin, int* val, int* val2);
 
-/******************************************************************************
+/**
  * luat_adc_close
  * Description: 关闭adc通道
  * @param pin[in] adc通道的序号
  * @return 0 成功, 其他值为失败
-******************************************************************************/
+ */
 int luat_adc_close(int pin);
 
-/******************************************************************************
+/**
  * luat_adc_global_config
  * Description: 设置adc全局参数
  * @param tp[in]  参数类型
  * @param val[in] 参数值
  * @return 0 成功, 其他值为失败
-******************************************************************************/
+ */
 int luat_adc_global_config(int tp, int val);
-
+/** @}*/
 #endif