From c7decb4119be6fedda49f1eeb228b3457aee51ed Mon Sep 17 00:00:00 2001
From: fankesyooni <qzmmcn@163.com>
Date: Thu, 5 Oct 2023 00:37:15 +0800
Subject: [PATCH] docs: update api docs

---
 .../highcapable/yukihookapi/YukiHookAPI.md    | 40 +++++++------------
 .../xposed/InjectYukiHookWithXposed.md        |  5 +++
 .../highcapable/yukihookapi/YukiHookAPI.md    | 38 ++++++------------
 .../xposed/InjectYukiHookWithXposed.md        |  5 +++
 4 files changed, 37 insertions(+), 51 deletions(-)

diff --git a/docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md b/docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
index f2c1c4d0..b057756c 100644
--- a/docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
+++ b/docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
@@ -172,7 +172,7 @@ val isModuleActive: Boolean
 
 在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。
 
@@ -194,7 +194,7 @@ val isXposedModuleActive: Boolean
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中始终返回 true。
 
@@ -234,11 +234,11 @@ val isSupportResourcesHook: Boolean
 
 **Function Illustrate**
 
-> 判断当前 Hook Framework 是否支持资源钩子(Resources Hook)。
+> 判断当前 Hook Framework 是否支持资源钩子 (Resources Hook)。
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。
 
@@ -276,7 +276,7 @@ val name: String
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -296,7 +296,7 @@ val type: ExecutorType
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -316,7 +316,7 @@ val apiLevel: Int
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -336,7 +336,7 @@ val versionName: String
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -356,7 +356,7 @@ val versionCode: Int
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -468,27 +468,15 @@ var isEnableModuleAppResourcesCache: Boolean
 
 :::
 
-### isEnableHookModuleStatus <span class="symbol">- field</span>
+<h3 class="deprecated">isEnableHookModuleStatus - field</h3>
 
-```kotlin:no-line-numbers
-var isEnableHookModuleStatus: Boolean
-```
-
-**Change Records**
+**变更记录**
 
 `v1.0.88` `added`
 
-**Function Illustrate**
+`v1.2.0` `deprecated`
 
-> 是否启用 Hook Xposed 模块激活等状态功能.
-
-为原生支持 Xposed 模块激活状态检测，此功能默认启用。
-
-::: warning
-
-关闭后你将不能再在模块环境中使用 **YukiHookAPI.Status** 中的激活状态判断功能。
-
-:::
+请手动迁移到 `InjectYukiHookWithXposed.isUsingXposedModuleStatus`
 
 ### isEnableHookSharedPreferences <span class="symbol">- field</span>
 
@@ -639,7 +627,7 @@ object HookEntry : IYukiHookXposedInit {
         )
         YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG
         YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true
-        YukiHookAPI.Configs.isEnableHookModuleStatus = true
+        YukiHookAPI.InjectYukiHookWithXposed.isUsingXposedModuleStatus = true
         YukiHookAPI.Configs.isEnableHookSharedPreferences = false
         YukiHookAPI.Configs.isEnableDataChannel = true
     }
diff --git a/docs-source/src/en/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md b/docs-source/src/en/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
index 0e6567e0..9d3403d0 100644
--- a/docs-source/src/en/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
+++ b/docs-source/src/en/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
@@ -17,6 +17,7 @@ annotation class InjectYukiHookWithXposed(
     val sourcePath: String,
     val modulePackageName: String,
     val entryClassName: String,
+    val isUsingXposedModuleStatus: Boolean,
     val isUsingResourcesHook: Boolean
 )
 ```
@@ -33,6 +34,10 @@ annotation class InjectYukiHookWithXposed(
 
 新增 `isUsingResourcesHook` 参数
 
+`v1.2.0` `modified`
+
+新增 `isUsingXposedModuleStatus` 参数
+
 **Function Illustrate**
 
 > 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。
diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
index 3cdcc4ff..8df52469 100644
--- a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
+++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
@@ -164,7 +164,7 @@ val isModuleActive: Boolean
 
 在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。
 
@@ -186,7 +186,7 @@ val isXposedModuleActive: Boolean
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中始终返回 true。
 
@@ -226,11 +226,11 @@ val isSupportResourcesHook: Boolean
 
 **功能描述**
 
-> 判断当前 Hook Framework 是否支持资源钩子(Resources Hook)。
+> 判断当前 Hook Framework 是否支持资源钩子 (Resources Hook)。
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。
 
@@ -268,7 +268,7 @@ val name: String
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -288,7 +288,7 @@ val type: ExecutorType
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -308,7 +308,7 @@ val apiLevel: Int
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -328,7 +328,7 @@ val versionName: String
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -348,7 +348,7 @@ val versionCode: Int
 
 ::: warning
 
-在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。
+在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
 
 :::
 
@@ -460,27 +460,15 @@ var isEnableModuleAppResourcesCache: Boolean
 
 :::
 
-### isEnableHookModuleStatus <span class="symbol">- field</span>
-
-```kotlin:no-line-numbers
-var isEnableHookModuleStatus: Boolean
-```
+<h3 class="deprecated">isEnableHookModuleStatus - field</h3>
 
 **变更记录**
 
 `v1.0.88` `新增`
 
-**功能描述**
+`v1.2.0` `作废`
 
-> 是否启用 Hook Xposed 模块激活等状态功能.
-
-为原生支持 Xposed 模块激活状态检测，此功能默认启用。
-
-::: warning
-
-关闭后你将不能再在模块环境中使用 **YukiHookAPI.Status** 中的激活状态判断功能。
-
-:::
+请手动迁移到 `InjectYukiHookWithXposed.isUsingXposedModuleStatus`
 
 ### isEnableHookSharedPreferences <span class="symbol">- field</span>
 
@@ -631,7 +619,7 @@ object HookEntry : IYukiHookXposedInit {
         )
         YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG
         YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true
-        YukiHookAPI.Configs.isEnableHookModuleStatus = true
+        YukiHookAPI.InjectYukiHookWithXposed.isUsingXposedModuleStatus = true
         YukiHookAPI.Configs.isEnableHookSharedPreferences = false
         YukiHookAPI.Configs.isEnableDataChannel = true
     }
diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
index 371a860b..009933bf 100644
--- a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
+++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
@@ -9,6 +9,7 @@ annotation class InjectYukiHookWithXposed(
     val sourcePath: String,
     val modulePackageName: String,
     val entryClassName: String,
+    val isUsingXposedModuleStatus: Boolean,
     val isUsingResourcesHook: Boolean
 )
 ```
@@ -25,6 +26,10 @@ annotation class InjectYukiHookWithXposed(
 
 新增 `isUsingResourcesHook` 参数
 
+`v1.2.0` `修改`
+
+新增 `isUsingXposedModuleStatus` 参数
+
 **功能描述**
 
 > 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。