fix: rtc,的timezone函数的API文档没有正确的返回值描述.原因是@return

之后只有一个值,就当成参数处理了. 然后顺手把能找到的类似问题全修正

https://gitee.com/openLuat/LuatOS/issues/ICYZMA

components/airtalk/binding/luat_lib_airtalk.c

@@ -58,7 +58,7 @@ static int l_airtalk_handler(lua_State *L, void* ptr) {
 @int 单次解码帧数，如果缓冲没有足够的帧数，自动补0，默认值5，不能低于2，不能高于10，不能低于encode_cnt, decode_cnt * 4 必须是 encode_cnt的整数倍
 @int 对讲停止后，audio的pm状态，默认是audio.SHUTDOWN
 @int 多长时间判定对端长时间无数据发送，超过这个时间会上报event_error，用户决定接下来的操作。默认5000ms，单位ms
-@return nil
+@return nil 无返回值
 @usage
 mqttc = mqtt.create(nil,"120.55.137.106", 1884)
 airtalk.config(airtalk.PROTOCOL_MQTT, mqttc)
@@ -131,7 +131,7 @@ static int l_airtalk_on(lua_State *L) {
 /*
 airtalk启动
 @api airtalk.start()
-@return nil
+@return nil 无返回值
 @usage
 mqttc = mqtt.create(nil,"120.55.137.106", 1884)
 airtalk.config(airtalk.PROTOCOL_MQTT, mqttc)
@@ -150,7 +150,7 @@ static int l_airtalk_start(lua_State *L)
 配置airtalk RTP协议中的SSRC
 @api airtalk.set_ssrc(ssrc)
 @int/string ssrc，可以是int也是可以8字节string
-@return nil
+@return nil 无返回值
 @usage
 
 */
@@ -175,7 +175,7 @@ static int l_airtalk_set_ssrc(lua_State *L)
 配置airtalk mqtt类型语音数据的专用topic
 @api airtalk.set_topic(topic)
 @string topic
-@return nil
+@return nil 无返回值
 @usage
 airtalk.set_topic("xxxxxxxxxx")
 */
@@ -193,7 +193,7 @@ airtalk对讲工作启动/停止
 @boolean 启停控制，true开始，false停止
 @int 工作模式，见airtalk.MODE_XXX
 @int 音频采样率，目前只有8000和16000，默认16000
-@return nil
+@return nil 无返回值
 @usage
 --1对1对讲开始
 airtalk.speech(true,airtalk.MODE_PERSON,16000)
@@ -245,7 +245,7 @@ static int l_airtalk_speech(lua_State *L)
 //airtalk上行控制
 //@api airtalk.uplink(on_off)
 //@boolean  录音上行控制，true开始，false停止
-//@return nil
+//@return nil 无返回值
 //@usage
 //--开始录音
 //airtalk.uplink(true)
@@ -262,7 +262,7 @@ static int l_airtalk_speech(lua_State *L)
 airtalk的详细调试信息开关
 @api airtalk.debug(on_off)
 @boolean 调试信息开关，true打开，false关闭
-@return nil
+@return nil 无返回值
 */
 static int l_airtalk_debug(lua_State *L)
 {

components/io_queue/luat_lib_io_queue.c

@@ -48,7 +48,7 @@ int l_io_queue_capture_handler(lua_State *L, void* ptr)
 @int  硬件定时器id，默认用0，根据实际MCU确定，air105为0~5，与pwm共用，同一个通道号不能同时为pwm和ioqueue
 @int  一个完整周期需要的命令，可以比实际的多
 @int  重复次数,默认是1，如果写0则表示无限次数循环
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.init(0,10,5) --以timer0为时钟源初始化一个io操作队列，有10个有效命令，循环5次
 */
@@ -68,7 +68,7 @@ static int l_io_queue_init(lua_State *L) {
 @int  延时微调时间,0~255tick,总的延时时间是time_us * 1us_tick + time_tick
 @boolean 是否连续是连续延时，默认否，如果是，定时器在时间到后不会停止而是重新计时，
 从而实现在下一个setdelay命令前，每次调用delay都会重复相同时间延时，提高连续定时的精度
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.setdelay(0,10,0) --延时10us+0个tick
 ioqueue.setdelay(0,9,15,true) --延时9us+15个tick,在之后遇到delay命令时，会延时9us+15个tick
@@ -90,7 +90,7 @@ static int l_io_queue_set_delay(lua_State *L) {
 对io操作队列增加一次重复延时，在前面必须有setdelay且是连续延时
 @api  ioqueue.delay(hwtimer_id)
 @int  硬件定时器id
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.setdelay(0,9,15,true) --延时9us+15个tick,在之后遇到delay命令时，会延时9us+15个tick
 ioqueue.delay(0)
@@ -111,7 +111,7 @@ static int l_io_queue_delay(lua_State *L) {
 @boolean  是否是输入
 @int 上下拉模式,只能是0,gpio.PULLUP,gpio.PULLDOWN
 @int 初始输出电平
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.setgpio(0,17,true,gpio.PULLUP,0) --GPIO17设置成上拉输入
 ioqueue.setgpio(0,17,false,0,1)--GPIO17设置成默认上下拉输出高电平
@@ -136,7 +136,7 @@ static int l_io_queue_set_gpio(lua_State *L) {
 @api  ioqueue.input(hwtimer_id,pin)
 @int  硬件定时器id
 @int pin
-@return 无
+@return nil 无返回值
 @usage
 --- 对GPIO17进行输入读取
 ioqueue.input(0, 17)
@@ -155,7 +155,7 @@ static int l_io_queue_gpio_input(lua_State *L) {
 @int  硬件定时器id
 @int pin
 @int 输出电平
-@return 无
+@return nil 无返回值
 @usage
 -- 对GPIO17输出低电平
 ioqueue.output(0, 17, 0)
@@ -176,7 +176,7 @@ static int l_io_queue_gpio_output(lua_State *L) {
 @int 上下拉模式,只能是0,gpio.PULLUP,gpio.PULLDOWN
 @int 中断模式,只能是gpio.BOTH,gpio.RISING,gpio.FALLING
 @int 定时器最大计时时间 考虑到lua是int类型，最小0x10000, 最大值为0x7fffffff，默认为最大值
-@return 无
+@return nil 无返回值
 @usage
 -- 捕获指令
 ioqueue.setcap(0, 17, gpio.PULLUP, gpio.FALLING, 48000000)
@@ -199,7 +199,7 @@ static int l_io_queue_set_capture(lua_State *L) {
 对io操作队列增加捕获一次IO状态命令
 @api  ioqueue.capture(hwtimer_id)
 @int  硬件定时器id
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.capture(0)
 */
@@ -214,7 +214,7 @@ static int l_io_queue_capture_pin(lua_State *L) {
 @api  ioqueue.capend(hwtimer_id,pin)
 @int  硬件定时器id
 @int  pin
-@return 无
+@return nil 无返回值
 @usage
 -- 结束捕获
 ioqueue.capend(0, 17)
@@ -257,7 +257,7 @@ static int l_io_queue_get(lua_State *L) {
 启动io操作队列
 @api  ioqueue.start(hwtimer_id)
 @int  硬件定时器id
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.start(0)
 */
@@ -291,7 +291,7 @@ static int l_io_queue_stop(lua_State *L) {
 释放io操作队列的资源，下次使用必须重新init
 @api  ioqueue.release(hwtimer_id)
 @int  硬件定时器id
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.clear(0)
 */
@@ -305,7 +305,7 @@ static int l_io_queue_release(lua_State *L) {
 清空io操作队列
 @api  ioqueue.clear(hwtimer_id)
 @int  硬件定时器id
-@return 无
+@return nil 无返回值
 @usage
 ioqueue.clear(0)
 */
@@ -336,7 +336,7 @@ static int l_io_queue_is_done(lua_State *L) {
 @int 上下拉模式,只能是0,gpio.PULLUP,gpio.PULLDOWN
 @int 中断模式,只能是gpio.BOTH,gpio.RISING,gpio.FALLING
 @boolean  开关，默认是false关
-@return 无
+@return nil 无返回值
 @usage
 -- 对GPIO17进行外部中断捕获
 ioqueue.exti(17, gpio.PULLUP, gpio.BOTH, true)

components/lcd/luat_lib_lcd.c

@@ -552,7 +552,7 @@ lcd命令
 @int lcd命令模式下的命令值
 @int/zbuff lcd命令模式下的参数值，如果只有1个参数，可以用int，如果有多个，使用zbuff传入
 @int 参数长度，如果上一个参数是int，则忽略长度
-@return boolean
+@return boolean 成功与否
 @usage
 -- lcd命令
 lcd.cmd(0x21)
@@ -1921,7 +1921,7 @@ static const int l_lcd_draw_utf8(lua_State *L) {
 @int 帧同步时的地址值，只有无ram的屏幕需要，如果能用0x2c发送数据则不需要这个参数
 @int 行同步时的指令，一般情况和命令模式下的指令一致，只有无ram的屏幕需要，如果能用0x2c发送数据则不需要这个参数
 @int 行同步时的地址值，只有无ram的屏幕需要，如果能用0x2c发送数据则不需要这个参数
-@return nil
+@return nil 无返回值
 @usage
 -- sh8601z驱动ic所需的qspi配置
 lcd.qspi(0x02, 0x32, 0x12)
@@ -1945,7 +1945,7 @@ static int l_lcd_qspi_config(lua_State* L){
 /*
 用户使用脚本初始化LCD完成后，必须调用本API
 @api lcd.user_done()
-@return nil
+@return nil 无返回值
 */
 static int l_lcd_user_ctrl_done(lua_State* L){
 	lcd_dft_conf->is_init_done = 1;
@@ -1962,7 +1962,7 @@ static int l_lcd_user_ctrl_done(lua_State* L){
 @api lcd.setAcchw(type,enable)
 @number type 支持的类型, 可选,默认全部类型 目前支持 lcd.ACC_HW_JPEG lcd.ACC_HW_ALL
 @bool enable 开关, 可选 默认关闭 ture开启 false关闭
-@return nil
+@return nil 无返回值
 @usage
     lcd.setAcchw(lcd.ACC_HW_JPEG,false) -- 关闭硬件加速的jpeg解码功能
     lcd.setAcchw(lcd.ACC_HW_ALL,false) -- 关闭所有硬件加速

components/mlx90640-library/luat_lib_mlx90640.c

@@ -331,7 +331,7 @@ static int l_mlx90640_average_temp(lua_State *L) {
 /*
 获取vdd
 @api mlx90640.get_vdd()
-@return number vdd
+@return number 当前vdd
 */
 static int l_mlx90640_get_vdd(lua_State *L) {
     lua_pushnumber(L, vdd);

components/network/ulwip/binding/luat_lib_napt.c

@@ -149,7 +149,7 @@ static int l_napt_rebuild(lua_State *L) {
 /*
 检查和清理NAT表
 @api napt.check()
-@return nil
+@return nil 无返回值
 @usage
 -- 两次check之间没有数据包的映射记录,会被清理
 */

components/onewire/binding/luat_lib_onewire.c

@@ -21,7 +21,7 @@
 初始化单总线
 @api onewire.init(id)
 @int id, 硬件单总线编号,如果只有一条则随意填写
-@return nil
+@return nil 无返回值
 @usage
 onewire.init(0) --初始化硬件单总线
 */
@@ -46,7 +46,7 @@ static int l_onewire_init(lua_State *L)
 @int tLOW1, start信号到允许写的时间
 @int tRDV, start信号到允许读的时间
 @int tREC, 通信结束前恢复时间
-@return nil
+@return nil 无返回值
 @usage
 onewire.timing(0, false, 0, 500, 500, 15, 240, 65, 1, 15, 15, 2) --配置单总线时序匹配DS18B20，保留了点余量
 */
@@ -262,7 +262,7 @@ static int l_onewire_rx(lua_State *L)
 @api onewire.debug(id, onoff)
 @int id, GPIO模式对应GPIO编号,HW模式是硬件单总线编号,如果只有一条则随意填写
 @boolean onoff, true打开,false关闭
-@return nil
+@return nil 无返回值
 @usage
 onewire.debug(0, true)
 */
@@ -276,7 +276,7 @@ static int l_onewire_debug(lua_State *L)
 关闭单总线
 @api onewire.deinit(id)
 @int id, 硬件单总线编号,如果只有一条则随意填写
-@return nil
+@return nil 无返回值
 @usage
 onewire.deinit(0) --初始化硬件单总线
 */

lua/src/loslib.c

@@ -219,7 +219,7 @@ static int os_getenv (lua_State *L) {
 /*
 返回程序使用的按秒计 CPU 时间的近似值
 @api os.clock()
-@return 时间戳
+@return int 时间戳
 @usage
 -- 不推荐使用本API
 -- 如需要获取 时间戳, 请使用 os.time()
@@ -407,7 +407,7 @@ static int os_date (lua_State *L) {
 时间戳函数
 @api os.time(mytime)
 @table 日期时间的table
-@return 时间戳
+@return int 时间戳
 @usage
 -- 注意注意, 这个函数返回的是UTC时间戳
 -- 时间戳, 但lua下的精度只能到秒

luat/modules/luat_lib_adc.c

@@ -52,7 +52,7 @@ static int l_adc_open(lua_State *L) {
 设置ADC的测量范围，注意这个和具体芯片有关，目前只支持air105/Air780EXXX系列
 @api adc.setRange(range)
 @int range参数,与具体设备有关,比如air105填adc.ADC_RANGE_1_8和adc.ADC_RANGE_3_6
-@return nil
+@return nil 无返回值
 @usage
 -- 本函数要在调用adc.open之前就调用, 之后调用无效!!!
 

luat/modules/luat_lib_can.c

@@ -458,7 +458,7 @@ static int l_can_deinit(lua_State *L)
 CAN debug开关，打开后有更详细的打印
 @api can.debug(on_off)
 @boolean true打开，false关闭
-@return nil
+@return nil 无返回值
 @usage
 can.debug(true)
 */

luat/modules/luat_lib_crypto.c

@@ -708,7 +708,7 @@ static int l_crypt_hash_init(lua_State *L) {
 @api crypto.hash_update(stream, data)
 @userdata crypto.hash_init()创建的stream, 必选
 @string 待计算的数据,必选
-@return 无
+@return nil 无返回值
 @usage
 crypto.hash_update(stream, "OK")
 */

luat/modules/luat_lib_rtc.c

@@ -22,8 +22,8 @@ void LUAT_WEAK luat_rtc_set_tamp32(uint32_t tamp) {
 
 /*
 设置时钟
-@api rtc.set(tab)
-@table or int 时钟参数,见示例
+@api rtc.set(val)
+@table/int 时钟参数,见示例
 @return bool 成功返回true,否则返回nil或false
 @usage
 rtc.set({year=2021,mon=8,day=31,hour=17,min=8,sec=43})
@@ -277,6 +277,7 @@ static int l_rtc_timer_stop(lua_State *L){
 @api rtc.setBaseYear(Base_year)
 @int 基准年Base_year,通常1900
 @usage
+-- 本函数已经废弃, 不要使用
 rtc.setBaseYear(1900)
 */
 static int l_rtc_set_base_year(lua_State *L){
@@ -288,7 +289,7 @@ static int l_rtc_set_base_year(lua_State *L){
 读取或设置时区
 @api rtc.timezone(tz)
 @int 时区值,注意单位是1/4时区.例如东八区是 32,而非8. 可以不传
-@return 当前/设置后的时区值
+@return int 当前/设置后的时区值
 @usage
 -- 设置为东8区
 rtc.timezone(32)