HighCapable/YukiHookAPI
5
0
Fork 0
mirror of https://github.com/HighCapable/YukiHookAPI.git synced 2025-09-04 09:45:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix documentation contents bugs

Browse Source
This commit is contained in:
fankesyooni
2023-01-13 10:09:37 +08:00
parent 2b7ee6cf78
commit 9d512a0d7d
22 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs-source/src/.vuepress/configs/template.ts
View File

@@ -40,9 +40,9 @@ const navigationLinks = {
baseApiPath + 'hook/xposed/parasitic/activity/base/ModuleAppCompatActivity', baseApiPath + 'hook/xposed/parasitic/activity/base/ModuleAppCompatActivity',
baseApiPath + 'hook/xposed/parasitic/context/wrapper/ModuleContextThemeWrapper', baseApiPath + 'hook/xposed/parasitic/context/wrapper/ModuleContextThemeWrapper',
baseApiPath + 'hook/xposed/parasitic/reference/ModuleClassLoader', baseApiPath + 'hook/xposed/parasitic/reference/ModuleClassLoader',
baseApiPath + 'hook/xposed/bridge/dummy/YukiModuleResources', baseApiPath + 'hook/xposed/bridge/resources/YukiModuleResources',
baseApiPath + 'hook/xposed/bridge/dummy/YukiResources', baseApiPath + 'hook/xposed/bridge/resources/YukiResources',
baseApiPath + 'hook/xposed/bridge/dummy/YukiResForwarder', baseApiPath + 'hook/xposed/bridge/resources/YukiResForwarder',
baseApiPath + 'hook/xposed/bridge/event/YukiXposedEvent', baseApiPath + 'hook/xposed/bridge/event/YukiXposedEvent',
baseApiPath + 'hook/type/android/ComponentTypeFactory', baseApiPath + 'hook/type/android/ComponentTypeFactory',
baseApiPath + 'hook/type/android/GraphicsTypeFactory', baseApiPath + 'hook/type/android/GraphicsTypeFactory',

10
docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
View File

@@ -372,7 +372,7 @@ var isDebug: Boolean
> 是否启用 DEBUG 模式。 > 是否启用 DEBUG 模式。
默认为开启状态，开启后模块将会向 `Logcat` 和 `XposedBridge.log` 打印详细的 Hook 日志，关闭后仅会打印 `E` 级别的日志。 默认为开启状态，开启后模块将会向 `Logcat` 和 (Xposed) 宿主环境中的日志功能打印详细的 Hook 日志，关闭后仅会打印 `E` 级别的日志。
<h3 class="deprecated">isAllowPrintingLogs - field</h3> <h3 class="deprecated">isAllowPrintingLogs - field</h3>
@@ -536,12 +536,12 @@ inline fun configs(initiate: Configs.() -> Unit)
**Function Example** **Function Example**
你可以在 `HookEntryClass` 的 `onInit` 方法中调用 `configs` 方法和 `debugLog` 方法完成对 API 的功能配置，实时生效。 你可以在 Hook 入口类的 `onInit` 方法中调用 `configs` 方法和 `debugLog` 方法完成对 API 的功能配置，实时生效。
> The following example > The following example
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
YukiHookAPI.configs { YukiHookAPI.configs {
@@ -572,7 +572,7 @@ class HookEntryClass : IYukiHookXposedInit {
> The following example > The following example
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() = configs { override fun onInit() = configs {
debugLog { debugLog {
@@ -601,7 +601,7 @@ class HookEntryClass : IYukiHookXposedInit {
> The following example > The following example
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
YukiHookLogger.Configs.tag = "YukiHookAPI" YukiHookLogger.Configs.tag = "YukiHookAPI"

0
docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiModuleResources.md → docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiModuleResources.md
View File

0
docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiResForwarder.md → docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiResForwarder.md
View File

0
docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiResources.md → docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiResources.md
View File

2
docs-source/src/en/api/special-features/logger.md
View File

@@ -48,7 +48,7 @@ For example we only use `android.util.Log` to print logs.
loggerD(tag = "YukiHookAPI", msg = "This is a log", type = LoggerType.LOGD) loggerD(tag = "YukiHookAPI", msg = "This is a log", type = LoggerType.LOGD)
``` ```
Or just use `XposedBridge.log` to print the log, this method can only be used in the (Xposed) Host environment. Or just use the log function that in the (Xposed) Host environment to print the log, this method can only be used in the (Xposed) Host environment.
> The following example > The following example

12
docs-source/src/en/config/api-example.md
View File

@@ -138,7 +138,7 @@ As a child hooker, you can also call the `loadApp` method externally, and then d
> The following example > The following example
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase { override fun onHook() = encase {
loadApp(name = "com.example.demo", ChildCustomHooker) loadApp(name = "com.example.demo", ChildCustomHooker)
@@ -172,12 +172,12 @@ object FirstHooker : YukiBaseHooker() {
} }
``` ```
Once all Hookers are set up, you can load your Hooker in the `onHook` method of your `HookEntryClass`. Once all Hookers are set up, you can load your Hooker in the `onHook` method of your Hook entry class.
> The following example > The following example
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = override fun onHook() =
YukiHookAPI.encase(FirstHooker, SecondHooker, ThirdHooker ...) YukiHookAPI.encase(FirstHooker, SecondHooker, ThirdHooker ...)
@@ -189,7 +189,7 @@ Of course, we can also abbreviate it.
> The following example > The following example
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase(FirstHooker, SecondHooker, ThirdHooker ...) override fun onHook() = encase(FirstHooker, SecondHooker, ThirdHooker ...)
} }
@@ -285,7 +285,7 @@ encase {
> Sample Code 2 > Sample Code 2
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() { override fun onHook() {
// <Scenario 1> // <Scenario 1>
@@ -344,7 +344,7 @@ encase {
> Sample Code 2 > Sample Code 2
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() { override fun onHook() {
encase(CustomHooker) encase(CustomHooker)

4
docs-source/src/en/config/api-exception.md
View File

@@ -43,7 +43,7 @@ You try to load the `encase` method in the `onInit` or `onXposedEvent` method of
> The following example > The following example
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
// ❗ Wrong usage // ❗ Wrong usage
@@ -72,7 +72,7 @@ Please load the `encase` method in the `onHook` method.
> The following example > The following example
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
// Only the configs method can be loaded here // Only the configs method can be loaded here

2
docs-source/src/en/config/xposed-using.md
View File

@@ -238,7 +238,7 @@ class _YukiHookXposedInit : IXposedHookZygoteInit, IXposedHookLoadPackage {
### IYukiHookXposedInit Interface ### IYukiHookXposedInit Interface
The `IYukiHookXposedInit` interface that your `HookEntryClass` must implements it, which is the entry point for your Module App to start hooking. The `IYukiHookXposedInit` interface that your Hook entry class must implements it, which is the entry point for your Module App to start hooking.
::: tip ::: tip

2
docs-source/src/en/guide/home.md
View File

@@ -47,7 +47,7 @@ With `Kotlin`'s elegant `lambda` writing and `YukiHookAPI`, you can make your Ho
```kotlin ```kotlin
@InjectYukiHookWithXposed @InjectYukiHookWithXposed
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase { override fun onHook() = encase {
loadZygote { loadZygote {

2
docs-source/src/en/guide/quick-start.md
View File

@@ -218,6 +218,6 @@ For configuration details related to use as a Hook API, you can [click here](../
::: warning ::: warning
**YukiHookModuleStatus**, **YukiHookModulePrefs**, **YukiHookDataChannel** and Resources Hook functionality will not work when using a custom Hook Framework instead of the full Xposed Module. **YukiHookModulePrefs**, **YukiHookDataChannel** and Resources Hook functionality will not work when using a custom Hook Framework instead of the full Xposed Module.
::: :::

2
docs-source/src/en/index.md
View File

@@ -16,7 +16,7 @@ features:
details: A powerful, elegant, beautiful API built with Kotlin lambda can help you quickly implement members search and methods hooks. details: A powerful, elegant, beautiful API built with Kotlin lambda can help you quickly implement members search and methods hooks.
- title: Debugging Efficient - title: Debugging Efficient
details: A rich debug log function, detailing the name of each hooked method, time-consuming to find the class can quickly debug and find errors. details: A rich debug log function, detailing the name of each hooked method, time-consuming to find the class can quickly debug and find errors.
- title: Easy to transplant - title: Easy to Transplant
details: Native support for Xposed API usage, in any case, the supported Hook Framework with Xposed API can be quickly spliced with it. details: Native support for Xposed API usage, in any case, the supported Hook Framework with Xposed API can be quickly spliced with it.
- title: Obfuscate Support - title: Obfuscate Support
details: The built Xposed Module simply supports R8, obfuscate will not destroy the hook entry point, and no other configuration is required under R8. details: The built Xposed Module simply supports R8, obfuscate will not destroy the hook entry point, and no other configuration is required under R8.

10
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
View File

@@ -364,7 +364,7 @@ var isDebug: Boolean
> 是否启用 DEBUG 模式。 > 是否启用 DEBUG 模式。
默认为开启状态，开启后模块将会向 `Logcat` 和 `XposedBridge.log` 打印详细的 Hook 日志，关闭后仅会打印 `E` 级别的日志。 默认为开启状态，开启后模块将会向 `Logcat` 和 (Xposed) 宿主环境中的日志功能打印详细的 Hook 日志，关闭后仅会打印 `E` 级别的日志。
<h3 class="deprecated">isAllowPrintingLogs - field</h3> <h3 class="deprecated">isAllowPrintingLogs - field</h3>
@@ -528,12 +528,12 @@ inline fun configs(initiate: Configs.() -> Unit)
**功能示例** **功能示例**
你可以在 `HookEntryClass` 的 `onInit` 方法中调用 `configs` 方法和 `debugLog` 方法完成对 API 的功能配置，实时生效。 你可以在 Hook 入口类的 `onInit` 方法中调用 `configs` 方法和 `debugLog` 方法完成对 API 的功能配置，实时生效。
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
YukiHookAPI.configs { YukiHookAPI.configs {
@@ -564,7 +564,7 @@ class HookEntryClass : IYukiHookXposedInit {
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() = configs { override fun onInit() = configs {
debugLog { debugLog {
@@ -593,7 +593,7 @@ class HookEntryClass : IYukiHookXposedInit {
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntryClass : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
YukiHookLogger.Configs.tag = "YukiHookAPI" YukiHookLogger.Configs.tag = "YukiHookAPI"

0
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiModuleResources.md → docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiModuleResources.md
View File

0
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiResForwarder.md → docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiResForwarder.md
View File

0
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/dummy/YukiResources.md → docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/bridge/resources/YukiResources.md
View File

2
docs-source/src/zh-cn/api/special-features/logger.md
View File

@@ -46,7 +46,7 @@ loggerD(tag = "YukiHookAPI", msg = "This is a log")
loggerD(tag = "YukiHookAPI", msg = "This is a log", type = LoggerType.LOGD) loggerD(tag = "YukiHookAPI", msg = "This is a log", type = LoggerType.LOGD)
``` ```
或又仅使用 `XposedBridge.log` 来打印日志，此方法仅可在 (Xposed) 宿主环境使用。 或仅使用 (Xposed) 宿主环境中的日志功能来打印日志，此方法仅可在 (Xposed) 宿主环境使用。
> 示例如下 > 示例如下

12
docs-source/src/zh-cn/config/api-example.md
View File

@@ -138,7 +138,7 @@ object CustomHooker : YukiBaseHooker() {
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase { override fun onHook() = encase {
loadApp(name = "com.example.demo", ChildCustomHooker) loadApp(name = "com.example.demo", ChildCustomHooker)
@@ -172,12 +172,12 @@ object FirstHooker : YukiBaseHooker() {
} }
``` ```
搭建完全部 Hooker 后，你就可以在你的 `HookEntryClass` 入口类中的 `onHook` 方法中装载你的 Hooker 了。 搭建完全部 Hooker 后，你就可以在你的 Hook 入口类中的 `onHook` 方法中装载你的 Hooker 了。
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = override fun onHook() =
YukiHookAPI.encase(FirstHooker, SecondHooker, ThirdHooker ...) YukiHookAPI.encase(FirstHooker, SecondHooker, ThirdHooker ...)
@@ -189,7 +189,7 @@ class HookEntry : IYukiHookXposedInit {
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase(FirstHooker, SecondHooker, ThirdHooker ...) override fun onHook() = encase(FirstHooker, SecondHooker, ThirdHooker ...)
} }
@@ -284,7 +284,7 @@ encase {
> 示例代码 2 > 示例代码 2
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() { override fun onHook() {
// <情景1> // <情景1>
@@ -342,7 +342,7 @@ encase {
> 示例代码 2 > 示例代码 2
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() { override fun onHook() {
encase(CustomHooker) encase(CustomHooker)

4
docs-source/src/zh-cn/config/api-exception.md
View File

@@ -43,7 +43,7 @@ You cannot load a hooker in "onInit" or "onXposedEvent" method! Aborted
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
// ❗错误的使用方法 // ❗错误的使用方法
@@ -72,7 +72,7 @@ class HookEntry : IYukiHookXposedInit {
> 示例如下 > 示例如下
```kotlin ```kotlin
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onInit() { override fun onInit() {
// 这里只能装载 configs 方法 // 这里只能装载 configs 方法

2
docs-source/src/zh-cn/config/xposed-using.md
View File

@@ -232,7 +232,7 @@ class _YukiHookXposedInit : IXposedHookZygoteInit, IXposedHookLoadPackage {
### IYukiHookXposedInit 接口 ### IYukiHookXposedInit 接口
`IYukiHookXposedInit` 接口为你的 `HookEntryClass` 必须实现的接口，这是你的模块开始 Hook 的起点。 `IYukiHookXposedInit` 接口为你的 Hook 入口类必须实现的接口，这是你的模块开始 Hook 的起点。
::: tip ::: tip

2
docs-source/src/zh-cn/guide/home.md
View File

@@ -47,7 +47,7 @@
```kotlin ```kotlin
@InjectYukiHookWithXposed @InjectYukiHookWithXposed
class HookEntry : IYukiHookXposedInit { object HookEntry : IYukiHookXposedInit {
override fun onHook() = encase { override fun onHook() = encase {
loadZygote { loadZygote {

2
docs-source/src/zh-cn/guide/quick-start.md
View File

@@ -215,6 +215,6 @@ override fun attachBaseContext(base: Context?) {
::: warning ::: warning
使用自定义的 Hook Framework 而并非完整的 Xposed 模块时，**YukiHookModuleStatus**、**YukiHookModulePrefs**、**YukiHookDataChannel** 以及 Resources Hook 功能将失效。 使用自定义的 Hook Framework 而并非完整的 Xposed 模块时，**YukiHookModulePrefs**、**YukiHookDataChannel** 以及 Resources Hook 功能将失效。
::: :::