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

update: 更新disp和gtfont的描述

Wendal Chen 2 лет назад
Родитель
Сommit
8305aa8f59

+ 4 - 1
components/gtfont/luat_lib_gtfont.c

@@ -1,9 +1,12 @@
 /*
 @module  gtfont
-@summary gtfont高通字库模块 (测试高通字库芯片型号:GT5SLCD1E-1A)
+@summary 高通字库芯片
 @version 1.0
 @date    2021.11.11
 @tag LUAT_USE_GTFONT
+@usage
+-- 已测试字体芯片型号 GT5SLCD1E-1A
+-- 如需要支持其他型号,请报issue
 */
 
 #include "luat_base.h"

+ 3 - 1
components/u8g2/luat_lib_disp.c

@@ -1,10 +1,12 @@
 /*
 @module  disp
-@summary disp库已合并到u8g2库,API等价
+@summary disp库(已废弃)
 @version 1.0
 @date    2020.03.30
 @demo u8g2
 @tag LUAT_USE_DISP
+@usage
+-- disp库已合并到u8g2库,API等价
 */
 #include "luat_base.h"
 #include "luat_malloc.h"

+ 2 - 6
tools/documentGenerator.py

@@ -55,9 +55,7 @@ s.write(json.dumps(snippet))
 s.close()
 
 make_doc_file.make("../../luatos-wiki/api/",modules,"🍴 LuatOS-SOC接口文档\n"+
-                                                    "==============\n\n"+
-                                                    "请点击左侧列表,查看各个接口。如需搜索,请直接使用搜索框进行搜索。\n\n"+
-                                                    ".. toctree::\n\n")
+                                                    "==============\n\n")
 
 
 
@@ -66,6 +64,4 @@ modules = api_get.get_modules(api_get.get_file_list([source_path+"/../script/lib
 modules.extend(api_get.get_modules(api_get.get_file_list([source_path+"/../script/libs"],".lua"),"--[[","]]"))
 
 make_doc_file.make("../../luatos-wiki/api/libs/",modules,"🥢 扩展库接口文档\n"+
-                                                        "==============\n\n"+
-                                                        "请点击左侧列表,查看各个接口。如需搜索,请直接使用搜索框进行搜索。\n\n"+
-                                                        ".. toctree::\n\n")
+                                                        "==============\n\n")