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

docs: update api docs

Browse Source
This commit is contained in:
fankesyooni
2023-10-04 03:10:25 +08:00
parent d04b9a5211
commit 3d149a92ca
7 changed files with 174 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -56,6 +56,7 @@ const navigationLinks = {
baseApiPath + 'hook/factory/YukiHookFactory',
baseApiPath + 'hook/entity/YukiBaseHooker',
baseApiPath + 'hook/core/api/compat/type/ExecutorType',
baseApiPath + 'hook/core/api/priority/YukiHookPriority',
baseApiPath + 'hook/core/YukiMemberHookCreator',
baseApiPath + 'hook/core/YukiResourcesHookCreator',
baseApiPath + 'hook/core/finder/members/MethodFinder',

42
docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md
View File

@@ -36,47 +36,35 @@ class YukiMemberHookCreator internal constructor(private val packageParam: Packa
> `YukiHookAPI` 的 `Member` 核心 Hook 实现类。
## PRIORITY_DEFAULT <span class="symbol">- field</span>
<h2 class="deprecated">PRIORITY_DEFAULT - field</h2>
```kotlin:no-line-numbers
val PRIORITY_DEFAULT: Int
```
**Change Records**
**变更记录**
`v1.0.80` `added`
**Function Illustrate**
`v1.2.0` `deprecated`
> 默认 Hook 回调优先级。
请迁移到 `YukiHookPriority`
## PRIORITY_LOWEST <span class="symbol">- field</span>
<h2 class="deprecated">PRIORITY_LOWEST - field</h2>
```kotlin:no-line-numbers
val PRIORITY_LOWEST: Int
```
**Change Records**
**变更记录**
`v1.0.80` `added`
**Function Illustrate**
`v1.2.0` `deprecated`
> 延迟回调 Hook 方法结果。
请迁移到 `YukiHookPriority`
## PRIORITY_HIGHEST <span class="symbol">- field</span>
<h2 class="deprecated">PRIORITY_HIGHEST - field</h2>
```kotlin:no-line-numbers
val PRIORITY_HIGHEST: Int
```
**Change Records**
**变更记录**
`v1.0.80` `added`
**Function Illustrate**
`v1.2.0` `deprecated`
> 更快回调 Hook 方法结果。
请迁移到 `YukiHookPriority`
## instanceClass <span class="symbol">- field</span>
@@ -121,7 +109,7 @@ val instanceClass: Class<*>
## injectMember <span class="symbol">- method</span>
```kotlin:no-line-numbers
inline fun injectMember(priority: Int, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result
inline fun injectMember(priority: YukiHookPriority, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result
```
**Change Records**
@@ -161,7 +149,7 @@ fun useDangerousOperation(option: String)
## MemberHookCreator <span class="symbol">- class</span>
```kotlin:no-line-numbers
inner class MemberHookCreator internal constructor(private val priority: Int)
inner class MemberHookCreator internal constructor(private val priority: YukiHookPriority)
```
**Change Records**
@@ -186,6 +174,8 @@ inner class MemberHookCreator internal constructor(private val priority: Int)
移除 `tag`
`priority` 类型由 `Int` 变更为 `YukiHookPriority`
**Function Illustrate**
> Hook 核心功能实现类，查找和处理需要 Hook 的 `Method`、`Constructor`。

71
docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md Normal file
View File

@@ -0,0 +1,71 @@
---
pageClass: code-page
---
::: warning
The English translation of this page has not been completed, you are welcome to contribute translations to us.
You can use the **Chrome Translation Plugin** to translate entire pages for reference.
:::
# YukiHookPriority <span class="symbol">- class</span>
```kotlin:no-line-numbers
enum class YukiHookPriority
```
**Change Records**
`v1.1.5` `added`
`v1.2.0` `modified`
移除 `internal` 对外公开
**Function Illustrate**
> Hook 回调优先级配置类。
## DEFAULT <span class="symbol">- enum</span>
```kotlin:no-line-numbers
DEFAULT
```
**Change Records**
`v1.1.5` `added`
**Function Illustrate**
> 默认 Hook 回调优先级。
## LOWEST <span class="symbol">- enum</span>
```kotlin:no-line-numbers
LOWEST
```
**Change Records**
`v1.1.5` `added`
**Function Illustrate**
> 延迟回调 Hook 方法结果。
## HIGHEST <span class="symbol">- enum</span>
```kotlin:no-line-numbers
HIGHEST
```
**Change Records**
`v1.1.5` `added`
**Function Illustrate**
> 更快回调 Hook 方法结果。

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

@@ -884,11 +884,11 @@ inline fun HookClass.hook(initiate: YukiMemberHookCreator.() -> Unit): YukiMembe
## Member+BaseFinder.BaseResult.hook <span class="symbol">- i-ext-method</span>
```kotlin:no-line-numbers
inline fun Member.hook(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun Member.hook(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun BaseFinder.BaseResult.hook(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun BaseFinder.BaseResult.hook(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
**Change Records**
@@ -908,15 +908,15 @@ inline fun BaseFinder.BaseResult.hook(initiate: YukiMemberHookCreator.MemberHook
## Array&lt;Member&gt;+List&lt;Member&gt;+BaseFinder.BaseResult.hookAll <span class="symbol">- i-ext-method</span>
```kotlin:no-line-numbers
inline fun Array<Member>.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun Array<Member>.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun List<Member>.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun List<Member>.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun BaseFinder.BaseResult.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun BaseFinder.BaseResult.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
**Change Records**

36
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.md
View File

@@ -28,47 +28,35 @@ class YukiMemberHookCreator internal constructor(private val packageParam: Packa
> `YukiHookAPI` 的 `Member` 核心 Hook 实现类。
## PRIORITY_DEFAULT <span class="symbol">- field</span>
```kotlin:no-line-numbers
val PRIORITY_DEFAULT: Int
```
<h2 class="deprecated">PRIORITY_DEFAULT - field</h2>
**变更记录**
`v1.0.80` `新增`
**功能描述**
`v1.2.0` `作废`
> 默认 Hook 回调优先级。
请迁移到 `YukiHookPriority`
## PRIORITY_LOWEST <span class="symbol">- field</span>
```kotlin:no-line-numbers
val PRIORITY_LOWEST: Int
```
<h2 class="deprecated">PRIORITY_LOWEST - field</h2>
**变更记录**
`v1.0.80` `新增`
**功能描述**
`v1.2.0` `作废`
> 延迟回调 Hook 方法结果。
请迁移到 `YukiHookPriority`
## PRIORITY_HIGHEST <span class="symbol">- field</span>
```kotlin:no-line-numbers
val PRIORITY_HIGHEST: Int
```
<h2 class="deprecated">PRIORITY_HIGHEST - field</h2>
**变更记录**
`v1.0.80` `新增`
**功能描述**
`v1.2.0` `作废`
> 更快回调 Hook 方法结果。
请迁移到 `YukiHookPriority`
## instanceClass <span class="symbol">- field</span>
@@ -113,7 +101,7 @@ val instanceClass: Class<*>
## injectMember <span class="symbol">- method</span>
```kotlin:no-line-numbers
inline fun injectMember(priority: Int, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result
inline fun injectMember(priority: YukiHookPriority, initiate: MemberHookCreator.() -> Unit): MemberHookCreator.Result
```
**变更记录**
@@ -153,7 +141,7 @@ fun useDangerousOperation(option: String)
## MemberHookCreator <span class="symbol">- class</span>
```kotlin:no-line-numbers
inner class MemberHookCreator internal constructor(private val priority: Int)
inner class MemberHookCreator internal constructor(private val priority: YukiHookPriority)
```
**变更记录**
@@ -178,6 +166,8 @@ inner class MemberHookCreator internal constructor(private val priority: Int)
移除 `tag`
`priority` 类型由 `Int` 变更为 `YukiHookPriority`
**功能描述**
> Hook 核心功能实现类，查找和处理需要 Hook 的 `Method`、`Constructor`。

63
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md Normal file
View File

@@ -0,0 +1,63 @@
---
pageClass: code-page
---
# YukiHookPriority <span class="symbol">- class</span>
```kotlin:no-line-numbers
enum class YukiHookPriority
```
**变更记录**
`v1.1.5` `新增`
`v1.2.0` `修改`
移除 `internal` 对外公开
**功能描述**
> Hook 回调优先级配置类。
## DEFAULT <span class="symbol">- enum</span>
```kotlin:no-line-numbers
DEFAULT
```
**变更记录**
`v1.1.5` `新增`
**功能描述**
> 默认 Hook 回调优先级。
## LOWEST <span class="symbol">- enum</span>
```kotlin:no-line-numbers
LOWEST
```
**变更记录**
`v1.1.5` `新增`
**功能描述**
> 延迟回调 Hook 方法结果。
## HIGHEST <span class="symbol">- enum</span>
```kotlin:no-line-numbers
HIGHEST
```
**变更记录**
`v1.1.5` `新增`
**功能描述**
> 更快回调 Hook 方法结果。

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

@@ -872,11 +872,11 @@ inline fun HookClass.hook(initiate: YukiMemberHookCreator.() -> Unit): YukiMembe
## Member+BaseFinder.BaseResult.hook <span class="symbol">- i-ext-method</span>
```kotlin:no-line-numbers
inline fun Member.hook(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun Member.hook(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun BaseFinder.BaseResult.hook(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun BaseFinder.BaseResult.hook(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
**变更记录**
@@ -896,15 +896,15 @@ inline fun BaseFinder.BaseResult.hook(initiate: YukiMemberHookCreator.MemberHook
## Array&lt;Member&gt;+List&lt;Member&gt;+BaseFinder.BaseResult.hookAll <span class="symbol">- i-ext-method</span>
```kotlin:no-line-numbers
inline fun Array<Member>.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun Array<Member>.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun List<Member>.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun List<Member>.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
```kotlin:no-line-numbers
inline fun BaseFinder.BaseResult.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
inline fun BaseFinder.BaseResult.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result
```
**变更记录**