docs: 修正文档内的内容

SmileYik · Jun 13, 2023 · 84a0dc6 · 84a0dc6
1 parent 9150cef
commit 84a0dc6
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 32 deletions.
diff --git a/docs/LuaHelper.md b/docs/LuaHelper.md
@@ -1,4 +1,4 @@
-
+
 ### getClass
 + **Description**:  通过全类名去获取java类类型.
 + **Return Type**: **Class<?>**
@@ -7,7 +7,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|name|**String**|全类名|
+|name|**String**|全类名|
 ### toIntArray
 + **Description**:  将Lua中只含整形的表转换为java中的整形数组.
 + **Return Type**: **int[]**
@@ -16,7 +16,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|只含整形的表（数组）.|
+|table|**LuaObject**|只含整形的表（数组）.|
 ### toIntArray
 + **Description**:  将Lua中只含整形的表转换为java中的整形数组.
 + **Return Type**: **int[]**
@@ -25,7 +25,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|只含整形的表（数组）.|
+|table|**LuaTable**|只含整形的表（数组）.|
 ### toDoubleArray
 + **Description**:  将Lua中只含浮点数的表转换为java中的double类型数组.
 + **Return Type**: **double[]**
@@ -34,7 +34,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|只含小数的表（数组）.|
+|table|**LuaObject**|只含小数的表（数组）.|
 ### toDoubleArray
 + **Description**:  将Lua中只含浮点数的表转换为java中的double类型数组.
 + **Return Type**: **double[]**
@@ -43,7 +43,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|只含小数的表（数组）.|
+|table|**LuaTable**|只含小数的表（数组）.|
 ### toFloatArray
 + **Description**:  将Lua中只含浮点数的表转换为java中的float类型数组.
 + **Return Type**: **float[]**
@@ -52,7 +52,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|只含小数的表（数组）.|
+|table|**LuaObject**|只含小数的表（数组）.|
 ### toFloatArray
 + **Description**:  将Lua中只含浮点数的表转换为java中的float类型数组.
 + **Return Type**: **float[]**
@@ -61,7 +61,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|只含小数的表（数组）.|
+|table|**LuaTable**|只含小数的表（数组）.|
 ### toStringArray
 + **Description**:  将Lua中只含字符串的表转换为java中的String类型数组.
 + **Return Type**: **String[]**
@@ -70,7 +70,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|只含字符串的表（数组）.|
+|table|**LuaObject**|只含字符串的表（数组）.|
 ### toStringArray
 + **Description**:  将Lua中只含字符串的表转换为java中的String类型数组.
 + **Return Type**: **String[]**
@@ -79,7 +79,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|只含字符串的表（数组）.|
+|table|**LuaTable**|只含字符串的表（数组）.|
 ### toArray
 + **Description**:  将Lua中只含指定类型的表转换为java中的指定类型数组.
 + **Return Type**: **T[]**
@@ -88,8 +88,8 @@
 
 |Name|Type|Description|
 |-|-|-|
-|t|**T**|需要转换成的Java类型实例.|
-|table|**LuaObject**|只含指定类型的表（数组）.|
+|t|**T**|需要转换成的Java类型实例.|
+|table|**LuaObject**|只含指定类型的表（数组）.|
 ### toArray
 + **Description**:  将Lua中只含指定类型的表转换为java中的指定类型数组.
 + **Return Type**: **T[]**
@@ -98,8 +98,8 @@
 
 |Name|Type|Description|
 |-|-|-|
-|t|**T**|需要转换成的Java类型实例.|
-|table|**LuaTable**|只含指定类型的表（数组）.|
+|t|**T**|需要转换成的Java类型实例.|
+|table|**LuaTable**|只含指定类型的表（数组）.|
 ### toObjectArray
 + **Description**:  将Lua中的表(数组)转换为java中的Object类型数组.
 + **Return Type**: **Object[]**
@@ -108,7 +108,7 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|表（数组）|
+|table|**LuaObject**|表（数组）|
 ### toObjectArray
 + **Description**:  将Lua中的表(数组)转换为java中的Object类型数组.
 + **Return Type**: **Object[]**
@@ -117,37 +117,37 @@
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|表（数组）|
+|table|**LuaTable**|表（数组）|
 ### toStringStringMap
 + **Description**:  将Lua中的只包含字符串的数组（下标为数字且未显式指定数字下标的Table）（如{"a", "b"}而非{2 = "b"}）转换为Java中的Map类型.
-+ **Return Type**: **String>**
++ **Return Type**: **Map<String, String>**
 + **Return Desc**: Map<String, String>类型HashMap.
 + **Usage**: `toStringStringMap(table:LuaObject)`
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|Lua中的表|
+|table|**LuaObject**|Lua中的表|
 ### toStringStringMap
 + **Description**:  将Lua中的只包含字符串的数组（下标为数字且未显式指定数字下标的Table）（如{"a", "b"}而非{2 = "b"}）转换为Java中的Map类型.
-+ **Return Type**: **String>**
++ **Return Type**: **Map<String, String>**
 + **Return Desc**: Map<String, String>类型HashMap.
 + **Usage**: `toStringStringMap(table:LuaTable)`
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaTable**|Lua中的表|
+|table|**LuaTable**|Lua中的表|
 ### toObjectObjectMap
 + **Description**:  将Lua中的数组（下标为数字且未显式指定数字下标的Table）（如{"a", "b"}而非{2 = "b"}）转换为Java中的Map类型.
-+ **Return Type**: **Object>**
++ **Return Type**: **Map<Object, Object>**
 + **Return Desc**: Map<Object, Object>类型HashMap.
 + **Usage**: `toObjectObjectMap(table:LuaObject)`
 
 |Name|Type|Description|
 |-|-|-|
-|table|**LuaObject**|Lua中的表|
+|table|**LuaObject**|Lua中的表|
 ### toObjectObjectMap
 + **Description**:  将Lua中的数组（下标为数字且未显式指定数字下标的Table）（如{"a", "b"}而非{2 = "b"}）转换为Java中的Map类型.
-+ **Return Type**: **Object>**
++ **Return Type**: **Map<Object, Object>**
 + **Return Desc**: Map<Object, Object>类型HashMap.
 + **Usage**: `toObjectObjectMap(table:LuaTable)`
 

diff --git a/docs/LuaPluginHelper.md b/docs/LuaPluginHelper.md
@@ -63,7 +63,7 @@
 + **Description**:  以插件身份发送一个HTTP请求.
 + **Return Type**: **void**
 + **Return Desc**: 
-+ **Usage**: `httpAction(plugin:LuaPlugin, urlString:String, method:String, body:byte[], connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, Map<String:, header:String>, useCaches:boolean, callback:Object, errorCallback:Object)`
++ **Usage**: `httpAction(plugin:LuaPlugin, urlString:String, method:String, body:byte[], connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, header:Map<String,String>, useCaches:boolean, callback:Object, errorCallback:Object)`
 
 |Name|Type|Description|
 |-|-|-|
@@ -74,16 +74,15 @@
 |connectTimeout|**int**|连接等待时间(毫秒).|
 |readTimeout|**int**|读取等待时间(毫秒).|
 |instanceFollowRedirects|**boolean**|是否跟随重定向.|
-|Map<String|****|null|
-|header|**String>**|需要添加的请求头，为null则代表不需要添加.|
+|header|**Map<String, String>**|需要添加的请求头，为null则代表不需要添加.|
 |useCaches|**boolean**|是否使用缓存.|
 |callback|**Object**|一个Lua函数闭包，会将ResponseCode以及HTTP请求的文本结果作为字符串传递给闭包.|
 |errorCallback|**Object**|一个Lua函数闭包，其只在运行过程中出现错误时调用，会将Exception实例传给闭包.|
 ### httpAction
 + **Description**:  以插件身份发送一个HTTP请求.
 + **Return Type**: **void**
 + **Return Desc**: 
-+ **Usage**: `httpAction(plugin:LuaPlugin, urlString:String, method:String, body:String, bodyEncode:String, connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, Map<String:, header:String>, useCaches:boolean, callback:Object, errorCallback:Object)`
++ **Usage**: `httpAction(plugin:LuaPlugin, urlString:String, method:String, body:String, bodyEncode:String, connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, header:Map<String,String>, useCaches:boolean, callback:Object, errorCallback:Object)`
 
 |Name|Type|Description|
 |-|-|-|
@@ -95,16 +94,15 @@
 |connectTimeout|**int**|连接等待时间(毫秒).|
 |readTimeout|**int**|读取等待时间(毫秒).|
 |instanceFollowRedirects|**boolean**|是否跟随重定向.|
-|Map<String|****|null|
-|header|**String>**|需要添加的请求头，为null则代表不需要添加.|
+|header|**Map<String, String>**|需要添加的请求头，为null则代表不需要添加.|
 |useCaches|**boolean**|是否使用缓存.|
 |callback|**Object**|一个Lua函数闭包，会将ResponseCode以及HTTP请求的文本结果作为字符串传递给闭包.|
 |errorCallback|**Object**|一个Lua函数闭包，其只在运行过程中出现错误时调用，会将Exception实例传给闭包.|
 ### httpGet
 + **Description**:  以插件身份发送一个HTTP的GET请求.
 + **Return Type**: **void**
 + **Return Desc**: 
-+ **Usage**: `httpGet(plugin:LuaPlugin, urlString:String, connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, Map<String:, header:String>, useCaches:boolean, callback:Object, errorCallback:Object)`
++ **Usage**: `httpGet(plugin:LuaPlugin, urlString:String, connectTimeout:int, readTimeout:int, instanceFollowRedirects:boolean, header:Map<String,String>, useCaches:boolean, callback:Object, errorCallback:Object)`
 
 |Name|Type|Description|
 |-|-|-|
@@ -113,8 +111,7 @@
 |connectTimeout|**int**|连接等待时间(毫秒).|
 |readTimeout|**int**|读取等待时间(毫秒).|
 |instanceFollowRedirects|**boolean**|是否跟随重定向.|
-|Map<String|****|null|
-|header|**String>**|需要添加的请求头，为null则代表不需要添加.|
+|header|**Map<String, String>**|需要添加的请求头，为null则代表不需要添加.|
 |useCaches|**boolean**|是否使用缓存.|
 |callback|**Object**|一个Lua函数闭包，会将ResponseCode以及HTTP请求的文本结果作为字符串传递给闭包.|
 |errorCallback|**Object**|一个Lua函数闭包，其只在运行过程中出现错误时调用，会将Exception实例传给闭包.|