From d2042daf5f2cd4a134f8c842770f9b864164bd89 Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Thu, 29 Dec 2022 23:28:21 +0800 Subject: [PATCH] Modify add onInit method's suggestion in quick-start documentation --- docs-source/src/en/guide/quick-start.md | 16 +++++++++++++++- docs-source/src/zh-cn/guide/quick-start.md | 14 +++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs-source/src/en/guide/quick-start.md b/docs-source/src/en/guide/quick-start.md index e5de51b8..9d825b23 100644 --- a/docs-source/src/en/guide/quick-start.md +++ b/docs-source/src/en/guide/quick-start.md @@ -154,7 +154,21 @@ class HookEntry : IYukiHookXposedInit { ::: tip Suggestion -You can extends **Application** of your Module App from **ModuleApplication** to achieve a complete user experience. +Please configure **YukiHookAPI** in the **onInit** method and set the **isDebug** mode to the following form. + +> The following example + +```kotlin +override fun onInit() = configs { + isDebug = BuildConfig.DEBUG +} +``` + +**YukiHookAPI** will print all logs for debugging by default. + +For a release build, be sure to turn off debugging to prevent a lot of log stuffing on the user's device. + +You can also extends **Application** of your Module App from **ModuleApplication** to achieve a complete user experience. For more functions, please refer to [ModuleApplication](../api/public/com/highcapable/yukihookapi/hook/xposed/application/ModuleApplication). diff --git a/docs-source/src/zh-cn/guide/quick-start.md b/docs-source/src/zh-cn/guide/quick-start.md index c1983b34..b4ac64c7 100644 --- a/docs-source/src/zh-cn/guide/quick-start.md +++ b/docs-source/src/zh-cn/guide/quick-start.md @@ -153,7 +153,19 @@ class HookEntry : IYukiHookXposedInit { ::: tip 建议 -你可以将你的模块 APP 的 **Application** 继承于 **ModuleApplication** 以实现完整使用体验。 +请在 **onInit** 方法中配置 **YukiHookAPI** 并将 **isDebug** 模式设置为如下形式。 + +> 示例如下 + +```kotlin +override fun onInit() = configs { + isDebug = BuildConfig.DEBUG +} +``` + +**YukiHookAPI** 默认会打印所有用于调试的日志,若作为发布版本请务必关闭调试功能防止对用户设备造成大量日志填充。 + +你还可以将你的模块 APP 的 **Application** 继承于 **ModuleApplication** 以实现完整使用体验。 更多功能请参考 [ModuleApplication](../api/public/com/highcapable/yukihookapi/hook/xposed/application/ModuleApplication)。