Fix documentation contents bugs

This commit is contained in:
2023-01-13 10:09:37 +08:00
parent 2b7ee6cf78
commit 9d512a0d7d
22 changed files with 38 additions and 38 deletions

View File

@@ -364,7 +364,7 @@ var isDebug: Boolean
> 是否启用 DEBUG 模式。
默认为开启状态,开启后模块将会向 `Logcat` 和 `XposedBridge.log` 打印详细的 Hook 日志,关闭后仅会打印 `E` 级别的日志。
默认为开启状态,开启后模块将会向 `Logcat` 和 (Xposed) 宿主环境中的日志功能打印详细的 Hook 日志,关闭后仅会打印 `E` 级别的日志。
<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
class HookEntryClass : IYukiHookXposedInit {
object HookEntry : IYukiHookXposedInit {
override fun onInit() {
YukiHookAPI.configs {
@@ -564,7 +564,7 @@ class HookEntryClass : IYukiHookXposedInit {
> 示例如下
```kotlin
class HookEntryClass : IYukiHookXposedInit {
object HookEntry : IYukiHookXposedInit {
override fun onInit() = configs {
debugLog {
@@ -593,7 +593,7 @@ class HookEntryClass : IYukiHookXposedInit {
> 示例如下
```kotlin
class HookEntryClass : IYukiHookXposedInit {
object HookEntry : IYukiHookXposedInit {
override fun onInit() {
YukiHookLogger.Configs.tag = "YukiHookAPI"

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)
```
仅使用 `XposedBridge.log` 来打印日志,此方法仅可在 (Xposed) 宿主环境使用。
或仅使用 (Xposed) 宿主环境中的日志功能来打印日志,此方法仅可在 (Xposed) 宿主环境使用。
> 示例如下

View File

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

View File

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

View File

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

View File

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

View File

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