From bc00f3c94579e7099459ff467181bdedc2b6fab3 Mon Sep 17 00:00:00 2001
From: lixianjing <xianjimli@hotmail.com>
Date: Thu, 27 Jul 2023 18:36:19 +0800
Subject: [PATCH] improve conf_io doc

---
 docs/changes.md             | 1 +
 docs/how_to_use_app_conf.md | 2 +-
 src/conf_io/README.md       | 9 +++++++--
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/changes.md b/docs/changes.md
index f8c484f66..10fad7aea 100644
--- a/docs/changes.md
+++ b/docs/changes.md
@@ -5,6 +5,7 @@
   * 修复克隆 rich\_text 对象失败的问题(感谢智明提供补丁)
   * 修复在 scrollable 的 tab\_button\_group 上面快速点击有概率会导致瞬移的问题(感谢智明提供补丁)
   * 完善layout(感谢兆坤提供补丁)
+  * 完善conf\_io的文档(感谢俊杰提供补丁);
 
 2023/07/26
   * 修改Windows下路径带中文时fs\_os\_get\_exe的返回结果不是utf8的问题(感谢朝泽提供补丁)
diff --git a/docs/how_to_use_app_conf.md b/docs/how_to_use_app_conf.md
index ff771f282..5e1960fd3 100644
--- a/docs/how_to_use_app_conf.md
+++ b/docs/how_to_use_app_conf.md
@@ -619,7 +619,7 @@ ret_t application_exit() {
 
 ## 9. 注意事项
 
-* . 作为 key 的分隔符。
+* 英文的点(.) 作为 key 的分隔符，所以 key 不能包含英文的点(.)。
 
 * ini 格式不支持注释和换行。
 
diff --git a/src/conf_io/README.md b/src/conf_io/README.md
index 1607fbcbc..33165ab4a 100644
--- a/src/conf_io/README.md
+++ b/src/conf_io/README.md
@@ -49,7 +49,7 @@ test.json 文件内容
         "age" : 100,
         "weight" : 60.5000
     }
-}c
+}
 ```
 
 示例代码
@@ -87,4 +87,9 @@ test.json 文件内容
   ASSERT_NE(conf, (object_t*)NULL);
 ```
 
-> 更多用法请参考：tests/conf_json_test.cc
\ No newline at end of file
+> 更多用法请参考：tests/conf_json_test.cc
+
+## 注意：
+
+ * 英文的点(.) 作为 key 的分隔符，所以 key 不能包含英文的点(.)。
+