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

fix: 更正所有不正确的返回值注释说明

chenxuuu 3 лет назад
Родитель
Сommit
1f1f958683

+ 3 - 3
components/lvgl/binding/luat_lib_lvgl.c

@@ -19,7 +19,7 @@
 /*
 获取当前活跃的screen对象
 @api lvgl.scr_act()
-@return screen指针
+@return 指针 screen指针
 @usage
 local scr = lvgl.scr_act()
 
@@ -32,7 +32,7 @@ static int luat_lv_scr_act(lua_State *L) {
 /*
 获取layer_top
 @api lvgl.layer_top()
-@return layer指针
+@return 指针 layer指针
 */
 static int luat_lv_layer_top(lua_State *L) {
     lua_pushlightuserdata(L, lv_layer_top());
@@ -42,7 +42,7 @@ static int luat_lv_layer_top(lua_State *L) {
 /*
 获取layer_sys
 @api lvgl.layer_sys()
-@return layer指针
+@return 指针 layer指针
 */
 static int luat_lv_layer_sys(lua_State *L) {
     lua_pushlightuserdata(L, lv_layer_sys());

+ 4 - 4
components/lvgl_v8/binding/luat_lib_lvgl.c

@@ -19,7 +19,7 @@
 /*
 获取当前活跃的screen对象
 @api lvgl.scr_act()
-@return screen指针
+@return 指针 screen指针
 @usage
 local scr = lvgl.scr_act()
 
@@ -32,7 +32,7 @@ static int luat_lv_scr_act(lua_State *L) {
 /*
 获取layout_top
 @api lvgl.layout_top()
-@return layout指针
+@return 指针 layout指针
 */
 static int luat_lv_layer_top(lua_State *L) {
     lua_pushlightuserdata(L, lv_layer_top());
@@ -42,7 +42,7 @@ static int luat_lv_layer_top(lua_State *L) {
 /*
 获取layout_sys
 @api lvgl.layout_sys()
-@return layout指针
+@return 指针 layout指针
 */
 static int luat_lv_layer_sys(lua_State *L) {
     lua_pushlightuserdata(L, lv_layer_sys());
@@ -283,4 +283,4 @@ void luat_lv_user_data_free(lv_obj_t * obj) {
     msg.arg2 = obj->user_data.signal_cb_ref;
     luat_msgbus_put(&msg, 0);
 }
-#endif
+#endif

+ 0 - 1
components/mlx90640-library/luat_lib_mlx90640.c

@@ -171,7 +171,6 @@ static int l_mlx90640_init(lua_State *L){
 /*
 取一帧数据
 @api mlx90640.feed()
-@return nil
 */
 static int l_mlx90640_feed(lua_State *L) {
     int status = MLX90640_GetFrameData(MLX90640_ADDR, frame);

+ 1 - 4
components/network/adapter/luat_lib_network.c

@@ -121,7 +121,7 @@ static int l_network_gc(lua_State *L)
 param1为申请的network_ctrl
 param2为具体的消息,只能是network.RESET, network.LINK, network.ON_LINE, network.TX_OK, network.RX_NEW, network.CLOSE等等
 param3为消息对应的参数
-@return 成功返回network_ctrl,失败返回nil
+@return some 成功返回network_ctrl,失败返回nil
 @usage
 local netc = network.create(network.ETH0, socket_cb_fun)	--以太网网卡上申请一个network_ctrl,通过socket_cb_fun回调相关消息
 local netc = network.create(network.ETH0, "IOT_TASK")	--以太网网卡上申请一个network_ctrl,通过sendMsg方式通知taskName为"IOT_TASK"回调相关消息
@@ -361,8 +361,6 @@ static int l_network_disconnect(lua_State *L)
 强制关闭socket
 @api network.close(ctrl)
 @user_data network.create得到的ctrl
-@return 无
-
 */
 static int l_network_close(lua_State *L)
 {
@@ -634,7 +632,6 @@ static int l_network_accept(lua_State *L)
 主动释放掉network_ctrl
 @api    network.release(ctrl)
 @user_data	network.create得到的ctrl
-@return 无
 @usage network.release(ctrl)
 */
 static int l_network_release(lua_State *L)

+ 1 - 1
components/statem/luat_lib_statem.c

@@ -15,7 +15,7 @@
 @api statem.create(count, repeat)
 @int 指令条数,默认32条
 @int 重复执行的次数, 0 代表不重复, 正整数代表具体重复执行的次数. 暂不支持永续执行
-@return 若成功,返回状态机指针,否则返回nil
+@return some 若成功,返回状态机指针,否则返回nil
 @usage
 gpio.setup(7, 0, gpio.PULLUP)
 gpio.setup(12, 0, gpio.PULLUP)

+ 1 - 2
components/usbapp/luat_lib_usbapp.c

@@ -51,7 +51,6 @@ USB 设置VID和PID
 @int 设备id,默认为0
 @int vid 小端格式
 @int pid 小端格式
-@return 无
 @usage
 usbapp.set_id(0, 0x1234, 0x5678)
 */
@@ -175,7 +174,7 @@ buff形式读接收到的数据,一次读出全部数据存入buff中,如果
 @api    usbapp.hid_rx(id, buff)
 @int 设备id,默认为0
 @zbuff zbuff对象
-@return 返回读到的长度,并把zbuff指针后移
+@return int 返回读到的长度,并把zbuff指针后移
 @usage
 usbapp.hid_rx(0, buff)
 */

+ 0 - 2
components/ymodem/luat_lib_ymodem.c

@@ -105,7 +105,6 @@ static int l_ymodem_receive(lua_State *L){
 重置ymodem处理过程,恢复到初始状态,一般用于接收出错后重置,从而进行下一次接收
 @api ymodem.reset(handler)
 @userdata handler
-@return 无
 @usage
 ymodem.reset(handler)
 */
@@ -120,7 +119,6 @@ static int l_ymodem_reset(lua_State *L){
 释放ymodem处理句柄
 @api ymodem.release(handler)
 @userdata handler
-@return 无
 @usage
 ymodem.release(handler)
 */

+ 1 - 1
luat/modules/luat_lib_i2s.c

@@ -22,7 +22,7 @@
 @int 格式, 当前仅支持i2s标准格式. 可选
 @int mclk频率, 默认 8M. 可选
 @return boolean 成功与否
-@return 底层返回值
+@return int 底层返回值
 @usage
 -- 这个库处于开发阶段, 尚不可用
 -- 以默认参数初始化i2s

+ 0 - 1
luat/modules/luat_lib_mcu.c

@@ -186,7 +186,6 @@ static int l_mcu_hw_diff_tick64(lua_State* L) {
 @boolean 高速时钟是否使用外部时钟源,如果为空则不改变
 @boolean 低速32K是否使用外部时钟源,如果为空则不改变
 @int PLL稳定时间,在切换高速时钟的时候,根据硬件环境,需要delay一段时间等待PLL稳定,默认是1200,建议不小于1024
-@return 无
 @usage
 mcu.setXTAL(true, true, 1248)	--高速时钟使用外部时钟,低速32K使用外部晶振, delay1248
 */

+ 2 - 2
luat/modules/luat_lib_uart.c

@@ -263,7 +263,7 @@ buff形式读串口,一次读出全部数据存入buff中,如果buff空间
 @api    uart.rx(id, buff)
 @int 串口id, uart0写0, uart1写1
 @zbuff zbuff对象
-@return 返回读到的长度,并把zbuff指针后移
+@return int 返回读到的长度,并把zbuff指针后移
 @usage
 uart.rx(1, buff)
 */
@@ -295,7 +295,7 @@ static int l_uart_rx(lua_State *L)
 读串口Rx缓存中剩余数据量,目前只有air105支持这个操作
 @api    uart.rx_size(id)
 @int 串口id, uart0写0, uart1写1
-@return 返回读到的长度
+@return int 返回读到的长度
 @usage
 local size = uart.rx_size(1)
 */

+ 1 - 3
luat/modules/luat_lib_zbuff.c

@@ -1013,7 +1013,6 @@ int __zbuff_resize(luat_zbuff_t *buff, uint32_t new_size)
 调整zbuff的大小(与当前指针位置无关;执行后如果指针超过zbuff大小,会被更改为指向最后一个字节)
 @api buff:resize(n)
 @int 新空间大小
-@return 无
 @usage
 buff:resize(20)
  */
@@ -1118,7 +1117,7 @@ static int l_zbuff_copy(lua_State *L)
 /**
 获取zbuff的实际数据量大小(与当前指针位置无关;执行后指针位置不变)
 @api buff:used()
-@return zbuff的实际数据量大小
+@return int zbuff的实际数据量大小
 @usage
 buff:used()
 */
@@ -1134,7 +1133,6 @@ static int l_zbuff_used(lua_State *L)
 @api buff:del(offset,length)
 @int 起始位置, 默认0,如果<0则从used往前数,-1 = used - 1
 @int 长度,默认为cursor指针位置
-@return 无
 @usage
 buff:del(1,4)	--从位置1开始删除4个字节数据
 */

+ 0 - 1
luat/packages/eink/luat_lib_eink.c

@@ -139,7 +139,6 @@ static int l_eink_setup(lua_State *L) {
 /**
 进入休眠模式,再次使用时需要重新初始化
 @api eink.sleep()
-@return nil
 */
 static int l_eink_sleep(lua_State *L)
 {