浏览代码

更新文档

drake 4 年之前
父节点
当前提交
db5bd69400
共有 3 个文件被更改,包括 7 次插入6 次删除
  1. 2 2
      docs/config.md
  2. 3 2
      docs/kotlin-serialization.md
  3. 2 2
      docs/scope.md

+ 2 - 2
docs/config.md

@@ -41,9 +41,9 @@
 
 | 函数 | 描述 |
 |-|-|
-| setLog | 日志 |
+| setLog | 输出网络异常日志 |
 | setHost | 全局域名, 和initNet("Host")函数中的第一个参数等效 |
-| setConverter | [转换器](converter.md) |
+| setConverter | [转换器](converter.md), 将网络返回的数据转换成你想要的数据结构 |
 | setRequestInterceptor | [请求拦截器](interceptor.md), 用于添加全局请求头/参数 |
 | onError | [全局错误处理](error-handle.md) |
 | onStateError | [全局缺省页错误处理](error-handle.md) |

+ 3 - 2
docs/kotlin-serialization.md

@@ -1,6 +1,6 @@
 从Net3开始支持使用[kotlin-serialization](https://github.com/Kotlin/kotlinx.serialization)(简称KS). 可以指定任何类泛型解析成任何数据结构返回,
 比如直接返回List/Map/Pair...
-
+<br>
 
 **Net是目前唯一支持kotlin-serialization转换器的网络请求库**
 
@@ -53,6 +53,7 @@ scopeNetLife {
 data class UserModel(var name: String, var age: Int, var height: Int)
 ```
 
-> 具体解析返回的JSON中的某个字段请在转换器里面自定
+> 具体解析返回的JSON中的某个字段请在转换器里面自定 <br>
+如果想详细了解KS, 请阅读文章: [Kotlin最强解析库 - kotlin-serialization](https://juejin.cn/post/6963676982651387935)
 
 

+ 2 - 2
docs/scope.md

@@ -12,7 +12,7 @@ Net的网络请求本身支持在官方的自带的作用域内使用, 但是考
 |-|-|
 |`scope`|创建最基础的作用域, 所有作用域都包含异常捕捉|
 |`scopeLife`|创建跟随生命周期取消的作用域|
-|`ViewModel.scopeLife`|创建跟随`ViewModel`生命周期的作用域|
+|`ViewModel.scopeLife`|创建跟随ViewModel生命周期的作用域, [如何在ViewModel创建作用域](view-model.md)|
 
 
 ## 网络请求的作用域
@@ -26,7 +26,7 @@ Net的网络请求本身支持在官方的自带的作用域内使用, 但是考
 |`scopeNet`|创建自动处理网络错误的作用域|
 |`scopeNetLife`|创建自动处理网络错误的作用域, 且包含跟随Activity或者Fragment生命周期|
 |`scopeDialog`|创建自动加载对话框的作用域, 生命周期跟随对话框|
-|`ViewModel.scopeNetLife`|创建跟随`ViewModel`生命周期的作用域|
+|`ViewModel.scopeNetLife`|创建跟随ViewModel生命周期的作用域, [如何在ViewModel创建作用域](view-model.md)|
 |`PageRefreshLayout.scope`|创建跟随[PageRefreshLayout](https://github.com/liangjingkanji/BRV)生命周期的作用域|
 |`StateLayout.scope`|创建跟随[StateLayout](https://github.com/liangjingkanji/BRV)生命周期的作用域|