diff --git a/docs/applet.md b/docs/applet.md index fd3a2a9a2..89eb3644c 100644 --- a/docs/applet.md +++ b/docs/applet.md @@ -6,7 +6,9 @@ AWTK 应用程序通常是一个单体的应用程序,里面所有的窗口都 ## 1. 使用方法 -### 1.1 设置小应用程序 (applet) 资源所在的根目录(所有的小应用程序 (applet) 的资源都安装到该目录下)。 +### 1.1 设置小应用程序 (applet) 资源所在的根目录 + +**所有的小应用程序 (applet) 的资源都安装到该目录下。** ```c /** diff --git a/docs/awtk_project_description_file.md b/docs/awtk_project_description_file.md index e81a78df7..7ee16ef27 100644 --- a/docs/awtk_project_description_file.md +++ b/docs/awtk_project_description_file.md @@ -235,8 +235,6 @@ usesSdk 是可选的,表示项目依赖的SDK的信息。 > 使用 scons 进行编译时,可以通过 AWTK_ROOT 参数手动设置 AWTK 的路径,比如: -```cmd +```bash scons AWTK_ROOT=c:/AWTK/SDK/awtk ``` - - diff --git a/docs/binding_custom_widget.md b/docs/binding_custom_widget.md index a8a2f8c55..3e44f4291 100644 --- a/docs/binding_custom_widget.md +++ b/docs/binding_custom_widget.md @@ -45,7 +45,7 @@ scons -j2 cd - ``` -### 5. 更新绑定代码 +## 5. 更新绑定代码 ``` git clone https://github.com/zlgopen/awtk-binding @@ -54,7 +54,7 @@ cd awtk-binding cd - ``` -### 6. 同步绑定代码到需要的语言 +## 6. 同步绑定代码到需要的语言 ``` git clone https://github.com/zlgopen/awtk-jerryscript @@ -63,7 +63,7 @@ cd awtk-jerryscript scons ``` -### 7. 注意 +## 7. 注意 * 开发应用程序时记得拷贝自定义控件的 style 到资源中。 * 如果代码下载太慢,可以从 fastgit 下载。 diff --git a/docs/changes.md b/docs/changes.md index 85977416e..83b83b8b6 100644 --- a/docs/changes.md +++ b/docs/changes.md @@ -1,6 +1,7 @@ # 最新动态 2022/07/05 + * 完善文档(感谢雨欣提供补丁) * 支持独立可以安装的applet,让它们具有独立的资源目录。 * 增加文档[支持可独立安装的小应用程序 (applet)](applet.md) diff --git a/docs/conf_doc.md b/docs/conf_doc.md index 71e73c8a8..a628742a1 100644 --- a/docs/conf_doc.md +++ b/docs/conf_doc.md @@ -245,7 +245,7 @@ tk_object_t* conf_xml_load(const char* url, bool_t create_if_not_exist); ret_t conf_xml_save_as(tk_object_t* obj, const char* url); ``` -## 3.3 INI 格式 +### 3.3 INI 格式 * 打开 diff --git a/docs/debug_tips.md b/docs/debug_tips.md index 8d0e1d890..51570762e 100644 --- a/docs/debug_tips.md +++ b/docs/debug_tips.md @@ -4,7 +4,7 @@ ## 一、输入设备相关问题 -### 1. 指针设备问题的检查列表: +### 1.1 指针设备问题的检查列表: * 设备名称是否正确。 * 电阻屏是否校准。 @@ -12,7 +12,7 @@ ## 二、显示相关问题 -### 1. 图片颜色不正常的检查列表: +### 2.1 图片颜色不正常的检查列表: * LCD 的格式是否正确。 * 图片格式是否正确。 diff --git a/docs/event_recorder_player.md b/docs/event_recorder_player.md index 050f34a9b..fbd6e8631 100644 --- a/docs/event_recorder_player.md +++ b/docs/event_recorder_player.md @@ -8,7 +8,7 @@ * 长时间运行进行压力测试。 * 辅助手工测试。有时出现崩溃的 BUG 时,往往忘记之前是如何操作的了,输入事件记录与重放可以精确重现问题。同时也可以减轻手工测试的工作量。 -## 2.API +## 2. API ```c /** diff --git a/docs/framebuffer.md b/docs/framebuffer.md index 95d7011fd..fa99056b6 100644 --- a/docs/framebuffer.md +++ b/docs/framebuffer.md @@ -1,6 +1,6 @@ ## FrameBuffer 的几种使用方式 -### 一、单 framebuffer。 +### 一、单 framebuffer 系统中只有一个 framebuffer,LCD 使用该 framebuffer 进行显示,GUI 使用该 framebuffer 进行绘制。 @@ -16,7 +16,9 @@ > 如果硬件能够解决动画颜色不正常的问题或者不需要动画,这种方式是最好的选择。 -### 二、双 framebuffer,一个 online 一个 offline,轮流切换显示。 +### 二、双 framebuffer(Swap) + +系统有两个 framebuffer,一个 online 一个 offline,轮流切换显示 * 1.GUI 在 offline 的 framebuffer 上绘制。 * 2.LCD 显示 online 的 framebuffer。 @@ -32,7 +34,9 @@ * GUI 每次都需要进行完整的绘制,不能只绘制变化的部分。 -### 三、双 framebuffer,一个固定 online 供 LCD 显示,一个固定 offline 供 GUI 绘制。 +### 三、双 framebuffer(Flush) + +系统有两个 framebuffer,一个固定 online 供 LCD 显示,一个固定 offline 供 GUI 绘制。 ![3](images/fb3.png) @@ -44,7 +48,9 @@ * 窗口动画时,可能整个屏幕都在变化,所以拷贝的量比较大。优化方法:对于平移的动画,可以让 GUI 直接往 online 的 framebuffer 上绘制,减少一次内存拷贝,而且不会出现闪烁。 -### 四、三个 framebuffer,一个 online 供 LCD 显示,一个 offline 供 GUI 绘制,一个为下一个要显示的 framebuffer。 +### 四、三个 framebuffer + +系统有三个 framebuffer,一个 online 供 LCD 显示,一个 offline 供 GUI 绘制,一个为下一个要显示的 framebuffer。 ![4](images/fb4.png) diff --git a/docs/fscript.md b/docs/fscript.md index ef90bcccf..929bcb735 100644 --- a/docs/fscript.md +++ b/docs/fscript.md @@ -1451,9 +1451,9 @@ clamp(2, 1, 3) ### 4.5 时间函数 > 已经移动到扩展模块。 -### 5. 自定义函数 +## 5. 自定义函数 -#### 5.1 定义函数 +### 5.1 定义函数 ```c static ret_t func_foo(object_t* obj, fscript_args_t* args, value_t* v) { @@ -1463,7 +1463,7 @@ static ret_t func_foo(object_t* obj, fscript_args_t* args, value_t* v) { } ``` -#### 5.2 注册和使用私有函数 +### 5.2 注册和使用私有函数 ```c value_t v; @@ -1476,7 +1476,7 @@ static ret_t func_foo(object_t* obj, fscript_args_t* args, value_t* v) { OBJECT_UNREF(obj); ``` -#### 5.3 注册全局函数 +### 5.3 注册全局函数 * 初始化时调用 @@ -1485,7 +1485,7 @@ fscript_register_func("foo", func_foo); ``` -#### 5.4 定义脚本函数 +### 5.4 定义脚本函数 * 函数定义 @@ -1535,7 +1535,7 @@ assert(foo4(10, 20) == 'awtk') assert(foo4(100, 200) == 'react-awtk') ``` -### 6. 性能测量与优化 +## 6. 性能测量与优化 runFScript 的第二个参数可以指定运行次数,方便测量某个函数的运行时间。 @@ -1553,7 +1553,7 @@ runFScript 的第二个参数可以指定运行次数,方便测量某个函数 ./bin/runFScript 'set(a, 2); set(b, 3); print(a+b)' ``` -### 7. 扩展模块 +## 7. 扩展模块 * [字符串扩展模块](fscript_str.md) * [位操作扩展模块](fscript_bits.md) @@ -1579,6 +1579,6 @@ runFScript 的第二个参数可以指定运行次数,方便测量某个函数 * [读缓冲区扩展模块](fscript_rbuffer.md) * [module扩展模块](fscript_module.md) -### 8. 更多示例 +## 8. 更多示例 请参考 tests/fscripts 目录。 diff --git a/docs/fscript_crc.md b/docs/fscript_crc.md index f0412028b..5b45485e3 100644 --- a/docs/fscript_crc.md +++ b/docs/fscript_crc.md @@ -59,7 +59,7 @@ cksum(binary) => uint16_t cksum("hello") ``` -### 4. 更多示例 +### 更多示例 ```js //test string diff --git a/docs/fscript_ram_req.md b/docs/fscript_ram_req.md index 4df26f8c1..4d50ed8c2 100644 --- a/docs/fscript_ram_req.md +++ b/docs/fscript_ram_req.md @@ -1,6 +1,6 @@ # fscript 内存需求评估 -## 一、测试环境 +## 1. 测试环境 测试使用的 AWTK 版本:AWTKv1.7,SHA-1: 5f570df4fc42a5a0050bae1d2fe8f99d6aa42532。 @@ -20,7 +20,7 @@ > 备注:以下测试均为无 GUI 界面的结果,即只跑 fscript 脚本。 -## 二、推荐的栈堆大小 +## 2. 推荐的栈堆大小 fscript **最低的栈(Stack)需求为 1.5 KB,最低的堆需求为 4 KB**,以上内存仅够初始化 fscript 基础模块和扩展模块,脚本代码只能做简单的运算以及打印信息。 @@ -67,7 +67,7 @@ fscript **最低的栈(Stack)需求为 1.5 KB,最低的堆需求为 4 KB** 3. 使用 if else 条件判断或 while 循环时,堆栈大小请根据条件分支数量以及循环次数适当调整; 4. 函数嵌套调用时,会消耗较多的堆栈空间,请尽量避免使用。 -## 三、堆空间的计算 +## 3. 堆空间的计算 ### 3.1 fscript 本身所需的 Heap @@ -104,7 +104,7 @@ fscript 初始化所需的 Heap 详见下表: 在 fscript 脚本中自定义函数(无参数、无返回值、无执行代码)内存(Heap)峰值会增加 350 字节左右。如果有传入参数以及返回值,请参考 3.2 章节计算内存。调用自定义函数与嵌套调用时消耗的内存与 fscript 内置函数一样。 -## 四、堆栈计算示例 +## 4. 堆栈计算示例 比如,我们需要计算以下 fscript 脚本所需的堆栈空间,步骤如下: diff --git a/docs/how_set_app_icon.md b/docs/how_set_app_icon.md index 6e4a4ecd2..440feefca 100644 --- a/docs/how_set_app_icon.md +++ b/docs/how_set_app_icon.md @@ -1,16 +1,17 @@ # 如何设置应用程序的图标 -## Windows +## 1. Windows -### 将应用程序的资源放到应用程序目录下的下列位置: +### 1.1 将应用程序的资源放到应用程序目录下的下列位置: ``` win32_res/awtk.res ``` -### 资源的生成方法 +### 1.2 资源的生成方法 可以在awtk/win32\_res基础之上修改,也可以完全自己制作。 -### 参考 +### 1.3 参考 + * [如何修改 Windows 下应用程序的图标](https://github.com/zlgopen/awtk/blob/master/win32_res/README.md) diff --git a/docs/how_to_enable_bidi.md b/docs/how_to_enable_bidi.md index b45c618fd..1eea7007d 100644 --- a/docs/how_to_enable_bidi.md +++ b/docs/how_to_enable_bidi.md @@ -15,7 +15,7 @@ >PC 版本默认已经定义。 - ### 2. 加入相关文件 + ## 2. 加入相关文件 ``` 3rd/fribidi/fribidi-arabic.c @@ -34,13 +34,13 @@ src/base/bidi.c >PC 版本默认已经加。 - ### 3. 控件的 bidi 属性 +## 3. 控件的 bidi 属性 - 默认情况下,文字的方向自动确定,如果在某些情况下,需要自己指定,可以通过 bidi 属性来实现。 +默认情况下,文字的方向自动确定,如果在某些情况下,需要自己指定,可以通过 bidi 属性来实现。 - 示例: +示例: - ```xml +```xml