add: 文档加上demo链接

components/camera/luat_lib_camera.c

@@ -4,6 +4,7 @@
 @summary 摄像头
 @version 1.0
 @date    2022.01.11
+@demo camera
 */
 #include "luat_base.h"
 #include "luat_camera.h"

components/flashdb/src/luat_lib_fdb.c

@@ -4,6 +4,7 @@
 @summary kv数据库(基于FlashDB)
 @version 1.0
 @date    2021.11.03
+@demo fdb
 */
 
 #include "luat_base.h"

components/io_queue/luat_lib_io_queue.c

@@ -4,6 +4,7 @@
 @summary io序列操作，配合硬件定时器力求达到us级，甚至更高
 @version 1.0
 @date    2022.03.13
+@demo io_queue
 */
 #include "luat_base.h"
 #include "luat_multimedia.h"

components/lcd/luat_lib_lcd.c

@@ -4,6 +4,7 @@
 @summary lcd驱动模块
 @version 1.0
 @date    2021.06.16
+@demo lcd
 */
 #include "luat_base.h"
 #include "luat_lcd.h"

components/multimedia/luat_lib_multimedia.c

@@ -4,6 +4,7 @@
 @summary 多媒体
 @version 1.0
 @date    2022.03.11
+@demo multimedia
 */
 #include "luat_base.h"
 #include "luat_multimedia.h"

components/network/adapter/luat_lib_network.c

@@ -3,6 +3,7 @@
 @summary 网络接口适配
 @version 1.0
 @date    2022.04.11
+@demo network
 */
 #include "luat_base.h"
 #ifdef LUAT_USE_NETWORK

components/sfud/luat_lib_sfud.c

@@ -3,6 +3,7 @@
 @summary SPI FLASH sfud软件包
 @version 1.0
 @date    2021.09.23
+@demo sfud
 */
 
 #include "luat_base.h"

components/statem/luat_lib_statem.c

@@ -4,6 +4,7 @@
 @summary SM状态机
 @version 1.0
 @date    2021.09.26
+@demo statem
 */
 
 #include "luat_base.h"

components/usbapp/luat_lib_usbapp.c

@@ -3,6 +3,7 @@
 @summary USB功能操作
 @version 1.0
 @date    2022.01.17
+@demo usb_hid
 */
 #include "luat_base.h"
 #include "luat_msgbus.h"

luat/modules/luat_lib_adc.c

@@ -4,6 +4,7 @@
 @summary 数模转换
 @version 1.0
 @date    2020.07.03
+@demo adc
 */
 #include "luat_base.h"
 #include "luat_adc.h"

luat/modules/luat_lib_crypto.c

@@ -4,6 +4,7 @@
 @summary 加解密和hash函数
 @version 1.0
 @date    2020.07.03
+@demo crypto
 */
 #include "luat_base.h"
 #include "luat_crypto.h"

luat/modules/luat_lib_ctiot.c

@@ -3,6 +3,7 @@
 @summary 中国电信CTIOT集成
 @version 1.0
 @date    2020.08.30
+@demo ctiot
 */
 #include "luat_base.h"
 #include "luat_timer.h"

luat/modules/luat_lib_dac.c

@@ -4,6 +4,7 @@
 @summary 数模转换
 @version 1.0
 @date    2021.12.03
+@demo multimedia
 */
 
 #include "luat_base.h"

luat/modules/luat_lib_fota.c

@@ -4,6 +4,7 @@
 @summary 底层固件升级
 @version core V0007
 @date    2022.05.26
+@demo ota
 */
 #include "luat_base.h"
 #include "luat_fota.h"

luat/modules/luat_lib_fs.c

@@ -4,6 +4,7 @@
 @summary 文件系统额外操作
 @version 1.0
 @date    2021.03.30
+@demo fs
 */
 #include "luat_base.h"
 #include "luat_fs.h"

luat/modules/luat_lib_gpio.c

@@ -5,6 +5,8 @@
 @catalog 外设API
 @version 1.0
 @date    2020.03.30
+@demo gpio
+@video https://www.bilibili.com/video/BV1hr4y1p7dt
 */
 #include "luat_base.h"
 #include "luat_gpio.h"

luat/modules/luat_lib_http.c

@@ -4,6 +4,7 @@
 @summary 执行http请求
 @version 1.0
 @date    2020.07.07
+@demo http
 */
 #include "luat_base.h"
 #include "luat_http.h"

luat/modules/luat_lib_i2c.c

@@ -4,6 +4,7 @@
 @summary I2C操作
 @version 1.0
 @date    2020.03.30
+@demo i2c
 */
 #include "luat_base.h"
 #include "luat_log.h"

luat/modules/luat_lib_ir.c

@@ -4,6 +4,7 @@
 @summary 红外遥控
 @version 1.0
 @date    2021.10.26
+@demo ir
 */
 #include "luat_base.h"
 #include "luat_gpio.h"

luat/modules/luat_lib_keyboard.c

@@ -4,6 +4,7 @@
 @summary 键盘矩阵(当前仅air105支持)
 @version 1.0
 @date    2021.11.24
+@demo keyboard
 */
 
 #include "luat_base.h"

luat/modules/luat_lib_libcoap.c

@@ -3,6 +3,7 @@
 @summary coap数据处理
 @version 1.0
 @date    2020.06.30
+@demo libcoap
 */
 #include "luat_base.h"
 #include "luat_timer.h"

luat/modules/luat_lib_pack.c

@@ -3,6 +3,7 @@
 @summary 打包和解包格式串
 @version 1.0
 @date    2021.12.20
+@video https://www.bilibili.com/video/BV1Sr4y1n7bP
 */
 
 #define	OP_ZSTRING	      'z'		/* zero-terminated string */

luat/modules/luat_lib_pm.c

@@ -4,6 +4,7 @@
 @summary 电源管理
 @version 1.0
 @date    2020.07.02
+@demo pm
 */
 #include "lua.h"
 #include "lauxlib.h"

luat/modules/luat_lib_pwm.c

@@ -3,6 +3,7 @@
 @summary PWM模块
 @version 1.0
 @date    2020.07.03
+@demo pwm
 */
 #include "luat_base.h"
 #include "luat_pwm.h"

luat/modules/luat_lib_rtc.c

@@ -3,6 +3,7 @@
 @summary 实时时钟
 @version 1.0
 @date    2021.08.31
+@demo rtc
 */
 #include "luat_base.h"
 #include "luat_rtc.h"

luat/modules/luat_lib_spi.c

@@ -3,6 +3,7 @@
 @summary spi操作库
 @version 1.0
 @date    2020.04.23
+@demo spi
 */
 #include "luat_base.h"
 #include "luat_log.h"

luat/modules/luat_lib_sys_doc.c

@@ -3,6 +3,7 @@
 @summary sys库
 @version 1.0
 @date    2019.11.23
+@video https://www.bilibili.com/video/BV1194y1o7q2
 */
 
 /*

luat/modules/luat_lib_uart.c

@@ -3,6 +3,8 @@
 @summary 串口操作库
 @version 1.0
 @date    2020.03.30
+@demo uart
+@video https://www.bilibili.com/video/BV1er4y1p75y
 */
 #include "luat_base.h"
 #include "luat_uart.h"

luat/modules/luat_lib_wdt.c

@@ -3,6 +3,7 @@
 @summary watchdog操作库
 @version 1.0
 @date    2021.08.06
+@demo wdt
 */
 #include "luat_base.h"
 #include "luat_wdt.h"

luat/packages/eink/luat_lib_eink.c

@@ -3,6 +3,7 @@
 @summary 墨水屏操作库
 @version 1.0
 @date    2020.11.14
+@demo eink
 */
 #include "luat_base.h"
 #include "luat_log.h"

luat/packages/lua-cjson/lua_cjson.c

@@ -3,6 +3,7 @@
 @summary json生成和解析库
 @version 1.0
 @date    2020.02.18
+@demo json
 */
 /* Lua CJSON - JSON support for Lua
  *

luat/packages/minmea/luat_lib_libgnss.c

@@ -4,6 +4,7 @@
 @summary NMEA数据处理
 @version 1.0
 @date    2020.07.03
+@demo libgnss
 */
 #include "luat_base.h"
 #include "luat_msgbus.h"

luat/packages/u8g2/luat_lib_disp.c

@@ -3,6 +3,7 @@
 @summary disp库已合并到u8g2库,API等价
 @version 1.0
 @date    2020.03.30
+@demo u8g2
 */
 #include "luat_base.h"
 #include "luat_malloc.h"

luat/packages/u8g2/luat_lib_u8g2.c

@@ -4,6 +4,7 @@
 @author  Dozingfiretruck
 @version 1.0
 @date    2021.01.25
+@demo u8g2
 */
 #include "luat_base.h"
 #include "luat_malloc.h"

tools/api_get.py

@@ -27,6 +27,8 @@ def get_file_list(paths, ext = ".c"):
 # @return 类型 返回的第一个值，这里是解释
 # @return string 返回的第二个值，类型为string
 # ...根据实际，列处所有返回值
+# @demo  demo路径
+# @video 视频链接
 # @usage
 # --使用的例子，可多行
 # lcoal a,b,c = module.function("test",nil,{1,2,3})
@@ -41,6 +43,9 @@ def get_file_list(paths, ext = ".c"):
 #         'module': 'adc',
 #         'summary': '数模转换',
 #         'url': 'https://xxxxxx',
+#         'demo': 'adc',
+#         'video': 'https://xxxxx',
+#         'usage': '--xxxxxxx',
 #         'api':[
 #             {
 #                 'api':'adc.read(id)',
@@ -94,6 +99,8 @@ def get_modules(file_list, start="/*", end="*/"):
             module["module"] = r.group(1)
             module["summary"] = r.group(2)
             module["usage"] = ""
+            module["demo"] = ""
+            module["video"] = ""
             module["api"] = []
         else:
             continue
@@ -112,13 +119,19 @@ def get_modules(file_list, start="/*", end="*/"):
             if lines[line_now].find(end) >= 0:
                 isGotApi = True #第一段注释结束了，不用找例子了
             if not isGotApi:#库自带的例子
-                arg = re.search(" *@usage *",lines[line_now],re.I)
-                if arg:
-                    isGotApi = True
+                if re.search(" *@demo *.+",lines[line_now],re.I):
+                    module["demo"] = "https://gitee.com/openLuat/LuatOS/tree/master/demo/"
+                    module["demo"] += re.search(" *@demo * (.+) *",lines[line_now],re.I).group(1)
+                    line_now+=1
+                if re.search(" *@video *.+",lines[line_now],re.I):
+                    module["video"] = re.search(" *@video * (.+) *",lines[line_now],re.I).group(1)
+                    line_now+=1
+                if re.search(" *@usage *",lines[line_now],re.I):
                     line_now+=1
                     while lines[line_now].find(end) < 0:
                         module["usage"] += lines[line_now]+"\n"
                         line_now+=1
+                    isGotApi = True
             #匹配api完整名称行
             name = re.search(r" *@api *(.+) *",lines[line_now+2],re.I)
             if not name:

tools/make_doc_file.py

@@ -17,6 +17,13 @@ def make(path,modules,index_text):
         if len(module["url"]) > 0:
             mdoc.write("> 本页文档由[这个文件]("+module["url"]+")自动生成。如有错误，请提交issue或帮忙修改后pr，谢谢！\n\n")
 
+        if len(module["demo"]) > 0:
+            mdoc.write("> 本库有专属demo，[点此链接查看"+module["module"]+"的demo例子]("+module["demo"]+")\n")
+        if len(module["video"]) > 0:
+            mdoc.write("> 本库还有视频教程，[点此链接查看]("+module["video"]+")\n\n")
+        else:
+            mdoc.write("\n")
+
         if len(module["usage"]) > 0:
             mdoc.write("**示例**\n\n")
             mdoc.write("```lua\n"+module["usage"]+"\n```\n\n")