From 3d149a92caf730b6957ce54279638cacb0b75b9d Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Wed, 4 Oct 2023 03:10:25 +0800 Subject: [PATCH] docs: update api docs --- docs-source/src/.vuepress/configs/template.ts | 1 + .../hook/core/YukiMemberHookCreator.md | 42 +++++------ .../core/api/priority/YukiHookPriority.md | 71 +++++++++++++++++++ .../yukihookapi/hook/param/PackageParam.md | 10 +-- .../hook/core/YukiMemberHookCreator.md | 36 ++++------ .../core/api/priority/YukiHookPriority.md | 63 ++++++++++++++++ .../yukihookapi/hook/param/PackageParam.md | 10 +-- 7 files changed, 174 insertions(+), 59 deletions(-) create mode 100644 docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md create mode 100644 docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md diff --git a/docs-source/src/.vuepress/configs/template.ts b/docs-source/src/.vuepress/configs/template.ts index 25230908..c169552f 100644 --- a/docs-source/src/.vuepress/configs/template.ts +++ b/docs-source/src/.vuepress/configs/template.ts @@ -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', 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 8dcfe1dc..27b80e9c 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 @@ -36,47 +36,35 @@ class YukiMemberHookCreator internal constructor(private val packageParam: Packa > `YukiHookAPI` 的 `Member` 核心 Hook 实现类。 -## PRIORITY_DEFAULT - field +

PRIORITY_DEFAULT - field

-```kotlin:no-line-numbers -val PRIORITY_DEFAULT: Int -``` - -**Change Records** +**变更记录** `v1.0.80` `added` -**Function Illustrate** +`v1.2.0` `deprecated` -> 默认 Hook 回调优先级。 +请迁移到 `YukiHookPriority` -## PRIORITY_LOWEST - field +

PRIORITY_LOWEST - field

-```kotlin:no-line-numbers -val PRIORITY_LOWEST: Int -``` - -**Change Records** +**变更记录** `v1.0.80` `added` -**Function Illustrate** +`v1.2.0` `deprecated` -> 延迟回调 Hook 方法结果。 +请迁移到 `YukiHookPriority` -## PRIORITY_HIGHEST - field +

PRIORITY_HIGHEST - field

-```kotlin:no-line-numbers -val PRIORITY_HIGHEST: Int -``` - -**Change Records** +**变更记录** `v1.0.80` `added` -**Function Illustrate** +`v1.2.0` `deprecated` -> 更快回调 Hook 方法结果。 +请迁移到 `YukiHookPriority` ## instanceClass - field @@ -121,7 +109,7 @@ val instanceClass: Class<*> ## injectMember - method ```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 - class ```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`。 diff --git a/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md new file mode 100644 index 00000000..afa9b839 --- /dev/null +++ b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md @@ -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 - class + +```kotlin:no-line-numbers +enum class YukiHookPriority +``` + +**Change Records** + +`v1.1.5` `added` + +`v1.2.0` `modified` + +移除 `internal` 对外公开 + +**Function Illustrate** + +> Hook 回调优先级配置类。 + +## DEFAULT - enum + +```kotlin:no-line-numbers +DEFAULT +``` + +**Change Records** + +`v1.1.5` `added` + +**Function Illustrate** + +> 默认 Hook 回调优先级。 + +## LOWEST - enum + +```kotlin:no-line-numbers +LOWEST +``` + +**Change Records** + +`v1.1.5` `added` + +**Function Illustrate** + +> 延迟回调 Hook 方法结果。 + +## HIGHEST - enum + +```kotlin:no-line-numbers +HIGHEST +``` + +**Change Records** + +`v1.1.5` `added` + +**Function Illustrate** + +> 更快回调 Hook 方法结果。 \ No newline at end of file diff --git a/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md index bb553e03..4d66b531 100644 --- a/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md +++ b/docs-source/src/en/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md @@ -884,11 +884,11 @@ inline fun HookClass.hook(initiate: YukiMemberHookCreator.() -> Unit): YukiMembe ## Member+BaseFinder.BaseResult.hook - i-ext-method ```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<Member>+List<Member>+BaseFinder.BaseResult.hookAll - i-ext-method ```kotlin:no-line-numbers -inline fun Array.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result +inline fun Array.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result ``` ```kotlin:no-line-numbers -inline fun List.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result +inline fun List.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** 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 3091738d..a75c6055 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 @@ -28,47 +28,35 @@ class YukiMemberHookCreator internal constructor(private val packageParam: Packa > `YukiHookAPI` 的 `Member` 核心 Hook 实现类。 -## PRIORITY_DEFAULT - field - -```kotlin:no-line-numbers -val PRIORITY_DEFAULT: Int -``` +

PRIORITY_DEFAULT - field

**变更记录** `v1.0.80` `新增` -**功能描述** +`v1.2.0` `作废` -> 默认 Hook 回调优先级。 +请迁移到 `YukiHookPriority` -## PRIORITY_LOWEST - field - -```kotlin:no-line-numbers -val PRIORITY_LOWEST: Int -``` +

PRIORITY_LOWEST - field

**变更记录** `v1.0.80` `新增` -**功能描述** +`v1.2.0` `作废` -> 延迟回调 Hook 方法结果。 +请迁移到 `YukiHookPriority` -## PRIORITY_HIGHEST - field - -```kotlin:no-line-numbers -val PRIORITY_HIGHEST: Int -``` +

PRIORITY_HIGHEST - field

**变更记录** `v1.0.80` `新增` -**功能描述** +`v1.2.0` `作废` -> 更快回调 Hook 方法结果。 +请迁移到 `YukiHookPriority` ## instanceClass - field @@ -113,7 +101,7 @@ val instanceClass: Class<*> ## injectMember - method ```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 - class ```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`。 diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md new file mode 100644 index 00000000..6f33ec19 --- /dev/null +++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/core/api/priority/YukiHookPriority.md @@ -0,0 +1,63 @@ +--- +pageClass: code-page +--- + +# YukiHookPriority - class + +```kotlin:no-line-numbers +enum class YukiHookPriority +``` + +**变更记录** + +`v1.1.5` `新增` + +`v1.2.0` `修改` + +移除 `internal` 对外公开 + +**功能描述** + +> Hook 回调优先级配置类。 + +## DEFAULT - enum + +```kotlin:no-line-numbers +DEFAULT +``` + +**变更记录** + +`v1.1.5` `新增` + +**功能描述** + +> 默认 Hook 回调优先级。 + +## LOWEST - enum + +```kotlin:no-line-numbers +LOWEST +``` + +**变更记录** + +`v1.1.5` `新增` + +**功能描述** + +> 延迟回调 Hook 方法结果。 + +## HIGHEST - enum + +```kotlin:no-line-numbers +HIGHEST +``` + +**变更记录** + +`v1.1.5` `新增` + +**功能描述** + +> 更快回调 Hook 方法结果。 \ No newline at end of file diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md index 30914f30..5eee6394 100644 --- a/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md +++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/hook/param/PackageParam.md @@ -872,11 +872,11 @@ inline fun HookClass.hook(initiate: YukiMemberHookCreator.() -> Unit): YukiMembe ## Member+BaseFinder.BaseResult.hook - i-ext-method ```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<Member>+List<Member>+BaseFinder.BaseResult.hookAll - i-ext-method ```kotlin:no-line-numbers -inline fun Array.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result +inline fun Array.hookAll(priority: YukiHookPriority, initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result ``` ```kotlin:no-line-numbers -inline fun List.hookAll(initiate: YukiMemberHookCreator.MemberHookCreator.() -> Unit): YukiMemberHookCreator.MemberHookCreator.Result +inline fun List.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 ``` **变更记录**