From 3f5114851c00bf889f1cf30d48226cfd3c32ed74 Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Wed, 4 Oct 2023 02:23:35 +0800 Subject: [PATCH] docs: update api docs --- .../hook/core/YukiMemberHookCreator.md | 102 ++++++------------ .../hook/core/YukiMemberHookCreator.md | 102 ++++++------------ 2 files changed, 62 insertions(+), 142 deletions(-) diff --git a/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md index 9a0cc885..8dcfe1dc 100644 --- a/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md +++ b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md @@ -102,11 +102,7 @@ val instanceClass: Class<*> ::: -## injectMember - method - -```kotlin:no-line-numbers -inline fun injectMember(priority: Int, tag: String, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result -``` +

injectMember - method

**Change Records** @@ -118,42 +114,24 @@ inline fun injectMember(priority: Int, tag: String, initiate: MemberHookCreator. 增加 `priority` Hook 优先级 +`v1.2.0` `deprecated` + +请迁移到另一个 `injectMember` + +## injectMember - method + +```kotlin:no-line-numbers +inline fun injectMember(priority: Int, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result +``` + +**Change Records** + +`v1.2.0` `added` + **Function Illustrate** > 注入要 Hook 的 `Method`、`Constructor`。 -**Function Example** - -你可以注入任意 `Method` 与 `Constructor`,使用 `injectMember` 即可创建一个 `Hook` 对象。 - -> The following example - -```kotlin -injectMember { - // Your code here. -} -``` - -你还可以自定义 `tag`,方便你在调试的时候能够区分你的 `Hook` 对象。 - -> The following example - -```kotlin -injectMember(tag = "KuriharaYuki") { - // Your code here. -} -``` - -你还可以自定义 `priority`,以控制当前 Hook 对象并列执行的优先级速度。 - -> The following example - -```kotlin -injectMember(priority = PRIORITY_HIGHEST) { - // Your code here. -} -``` - ## useDangerousOperation - method ```kotlin:no-line-numbers @@ -183,7 +161,7 @@ fun useDangerousOperation(option: String) ## MemberHookCreator - class ```kotlin:no-line-numbers -inner class MemberHookCreator internal constructor(private val priority: Int, internal val tag: String) +inner class MemberHookCreator internal constructor(private val priority: Int) ``` **Change Records** @@ -204,6 +182,10 @@ inner class MemberHookCreator internal constructor(private val priority: Int, in 修正拼写错误的 **Creater** 命名到 **Creator** +`v1.2.0` `modified` + +移除 `tag` + **Function Illustrate** > Hook 核心功能实现类,查找和处理需要 Hook 的 `Method`、`Constructor`。 @@ -314,11 +296,7 @@ inline fun constructor(initiate: ConstructorConditions): ConstructorFinder.Resul > 查找当前 `Class` 需要 Hook 的 `Constructor`。 -### HookParam.field - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.field(initiate: FieldConditions): FieldFinder.Result -``` +

HookParam.field - i-ext-method

**Change Records** @@ -328,59 +306,41 @@ inline fun HookParam.field(initiate: FieldConditions): FieldFinder.Result 将方法体进行 inline -**Function Illustrate** +`v1.2.0` `removed` -> 使用当前 `hookClass` 查找并得到 `Field`。 - -### HookParam.method - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.method(initiate: MethodConditions): MethodFinder.Result -``` +

HookParam.method - i-ext-method

**Change Records** -`v1.0.2` `first` +`v1.0.2` `added` `v1.0.80` `modified` 将方法体进行 inline -**Function Illustrate** +`v1.2.0` `removed` -> 使用当前 `hookClass` 查找并得到 `Method` 。 - -### HookParam.constructor - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.constructor(initiate: ConstructorConditions): ConstructorFinder.Result -``` +

HookParam.constructor - i-ext-method

**Change Records** -`v1.0.2` `first` +`v1.0.2` `added` `v1.0.80` `modified` 将方法体进行 inline -**Function Illustrate** +`v1.2.0` `removed` -> 使用当前 `hookClass` 查找并得到 `Constructor`。 - -### HookParam.injectMember - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.injectMember(priority: Int, tag: String, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result -``` +

HookParam.injectMember - i-ext-method

**Change Records** `v1.0.88` `added` -**Function Illustrate** +`v1.2.0` `deprecated` -> 注入要 Hook 的 `Method`、`Constructor` (嵌套 Hook)。 +嵌套 Hook 功能已弃用 ### before - method diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md index c224dcfe..3091738d 100644 --- a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md +++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md @@ -94,11 +94,7 @@ val instanceClass: Class<*> ::: -## injectMember - method - -```kotlin:no-line-numbers -inline fun injectMember(priority: Int, tag: String, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result -``` +

injectMember - method

**变更记录** @@ -110,42 +106,24 @@ inline fun injectMember(priority: Int, tag: String, initiate: MemberHookCreator. 增加 `priority` Hook 优先级 +`v1.2.0` `作废` + +请迁移到另一个 `injectMember` + +## injectMember - method + +```kotlin:no-line-numbers +inline fun injectMember(priority: Int, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result +``` + +**变更记录** + +`v1.2.0` `新增` + **功能描述** > 注入要 Hook 的 `Method`、`Constructor`。 -**功能示例** - -你可以注入任意 `Method` 与 `Constructor`,使用 `injectMember` 即可创建一个 `Hook` 对象。 - -> 示例如下 - -```kotlin -injectMember { - // Your code here. -} -``` - -你还可以自定义 `tag`,方便你在调试的时候能够区分你的 `Hook` 对象。 - -> 示例如下 - -```kotlin -injectMember(tag = "KuriharaYuki") { - // Your code here. -} -``` - -你还可以自定义 `priority`,以控制当前 Hook 对象并列执行的优先级速度。 - -> 示例如下 - -```kotlin -injectMember(priority = PRIORITY_HIGHEST) { - // Your code here. -} -``` - ## useDangerousOperation - method ```kotlin:no-line-numbers @@ -175,7 +153,7 @@ fun useDangerousOperation(option: String) ## MemberHookCreator - class ```kotlin:no-line-numbers -inner class MemberHookCreator internal constructor(private val priority: Int, internal val tag: String) +inner class MemberHookCreator internal constructor(private val priority: Int) ``` **变更记录** @@ -196,6 +174,10 @@ inner class MemberHookCreator internal constructor(private val priority: Int, in 修正拼写错误的 **Creater** 命名到 **Creator** +`v1.2.0` `修改` + +移除 `tag` + **功能描述** > Hook 核心功能实现类,查找和处理需要 Hook 的 `Method`、`Constructor`。 @@ -306,11 +288,7 @@ inline fun constructor(initiate: ConstructorConditions): ConstructorFinder.Resul > 查找当前 `Class` 需要 Hook 的 `Constructor`。 -### HookParam.field - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.field(initiate: FieldConditions): FieldFinder.Result -``` +

HookParam.field - i-ext-method

**变更记录** @@ -320,59 +298,41 @@ inline fun HookParam.field(initiate: FieldConditions): FieldFinder.Result 将方法体进行 inline -**功能描述** +`v1.2.0` `移除` -> 使用当前 `hookClass` 查找并得到 `Field`。 - -### HookParam.method - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.method(initiate: MethodConditions): MethodFinder.Result -``` +

HookParam.method - i-ext-method

**变更记录** -`v1.0.2` `添加` +`v1.0.2` `新增` `v1.0.80` `修改` 将方法体进行 inline -**功能描述** +`v1.2.0` `移除` -> 使用当前 `hookClass` 查找并得到 `Method` 。 - -### HookParam.constructor - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.constructor(initiate: ConstructorConditions): ConstructorFinder.Result -``` +

HookParam.constructor - i-ext-method

**变更记录** -`v1.0.2` `添加` +`v1.0.2` `新增` `v1.0.80` `修改` 将方法体进行 inline -**功能描述** +`v1.2.0` `移除` -> 使用当前 `hookClass` 查找并得到 `Constructor`。 - -### HookParam.injectMember - i-ext-method - -```kotlin:no-line-numbers -inline fun HookParam.injectMember(priority: Int, tag: String, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result -``` +

HookParam.injectMember - i-ext-method

**变更记录** `v1.0.88` `新增` -**功能描述** +`v1.2.0` `作废` -> 注入要 Hook 的 `Method`、`Constructor` (嵌套 Hook)。 +嵌套 Hook 功能已弃用 ### before - method