From dde8a41daf41146f54d69d3d907a58d4cf8d4c3f Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Wed, 15 Feb 2023 14:41:41 +0800
Subject: [PATCH] doc: update doc for xerror package

---
 README.md            | 27 +++++++++++++++++++++++++--
 README_zh-CN.md      | 29 ++++++++++++++++++++++++++---
 docs/xerror_zh-CN.md |  2 +-
 3 files changed, 52 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index d7b50a3..f285164 100644
--- a/README.md
+++ b/README.md
@@ -1176,9 +1176,32 @@ import "github.com/duke-git/lancet/v2/xerror"
 ```
 
 #### Function list:
-
--   **<big>Unwrap</big>** : check if err is nil then it returns a valid value. If err is not nil, Unwrap panics with err.
+-   **<big>New</big>** : creates a new XError pointer instance with message.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#New)]
+-   **<big>Wrap</big>** : creates a new XError pointer instance based on error object, and add message.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#Wrap)]
+-   **<big>Unwrap</big>** : returns unwrapped XError from err by errors.As. If no XError, returns nil.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#Unwrap)]
+-   **<big>XError_Wrap</big>** : creates a new XError and copy message and id to new one.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Wrap)]
+-   **<big>XError_Unwrap</big>** : Compatible with github.com/pkg/errors.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Unwrap)]
+-   **<big>XError_With</big>** : adds key and value related to the XError object.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_With)]
+-   **<big>XError_Id</big>** : sets XError object id to check equality in XError.Is.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Id)]
+-   **<big>XError_Is</big>** : checks if target error is XError and Error.id of two errors are matched.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Is)]
+-   **<big>XError_Values</big>** : returns map of key and value that is set by XError.With function. 
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Values)]
+-   **<big>XError_StackTrace</big>** : returns stack trace which is compatible with pkg/errors.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_StackTrace)]
+-   **<big>XError_Info</big>** : returns information of xerror, which can be printed.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Info)]
+-   **<big>XError_Error</big>** : implements standard error interface.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#XError_Error)]
+-   **<big>TryUnwrap</big>** : check if err is nil then it returns a valid value. If err is not nil, TryUnwrap panics with err.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#TryUnwrap)]
     [[play](https://go.dev/play/p/w84d7Mb3Afk)]
 
 
diff --git a/README_zh-CN.md b/README_zh-CN.md
index e1303c0..9bdc5ef 100644
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -1188,11 +1188,34 @@ import "github.com/duke-git/lancet/v2/xerror"
 
 #### 函数列表:
 
-
--   **<big>Unwrap</big>** : 检查error, 如果err为nil则展开，则它返回一个有效值，如果err不是nil则Unwrap使用err发生panic。
+-   **<big>New</big>** : 创建XError对象实例。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#New)]
+-   **<big>Wrap</big>** : 根据error对象创建XError对象实例，可添加message。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#Wrap)]
+-   **<big>Unwrap</big>** : 从error对象中解构出XError。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#Unwrap)]
+-   **<big>XError_Wrap</big>** : 创建新的XError对象并将消息和id复制到新的对象中。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Wrap)]
+-   **<big>XError_Unwrap</big>** : 解构XEerror为error对象。适配github.com/pkg/errors。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Unwrap)]
+-   **<big>XError_With</big>** : 添加与XError对象的键和值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_With)]
+-   **<big>XError_Id</big>** : 设置XError对象的id。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Id)]
+-   **<big>XError_Is</big>** : 检查目标error是否为XError，两个错误中的error.id是否匹配。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Is)]
+-   **<big>XError_Values</big>** : 返回由With设置的键和值的映射。将合并所有XError键和值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Values)]
+-   **<big>XError_StackTrace</big>** : 返回与pkg/error兼容的堆栈信息。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_StackTrace)]
+-   **<big>XError_Info</big>** : 返回可打印的XError对象信息。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Info)]
+-   **<big>XError_Error</big>** : 实现标准库的error接口。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#XError_Error)]
+-   **<big>TryUnwrap</big>** : 检查error, 如果err为nil则展开，则它返回一个有效值，如果err不是nil则Unwrap使用err发生panic。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#TryUnwrap)]
     [[play](https://go.dev/play/p/w84d7Mb3Afk)]
-
+    
 
 ## 如何贡献代码
 
diff --git a/docs/xerror_zh-CN.md b/docs/xerror_zh-CN.md
index eb90caa..9ac2870 100644
--- a/docs/xerror_zh-CN.md
+++ b/docs/xerror_zh-CN.md
@@ -241,7 +241,7 @@ func main() {
 
 ### <span id="XError_Id">XError_Id</span>
 
-<p>设置XError对象的id.</p>
+<p>设置XError对象的id。</p>
 
 <b>函数签名:</b>