From 4f8c2759c0c0e7e8ee37fcba1e33e308b9451108 Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Thu, 28 Jul 2022 00:08:51 +0800 Subject: [PATCH] Modify canonical code comment "constructor" naming --- docs/api/public/HookParam.md | 2 +- docs/api/public/PackageParam.md | 2 +- docs/api/public/ReflectionFactory.md | 2 +- docs/api/public/YukiMemberHookCreater.md | 10 +++++----- .../yukihookapi/hook/core/YukiMemberHookCreater.kt | 10 +++++----- .../yukihookapi/hook/core/finder/base/BaseFinder.kt | 2 +- .../yukihookapi/hook/factory/ReflectionFactory.kt | 2 +- .../highcapable/yukihookapi/hook/param/HookParam.kt | 2 +- .../highcapable/yukihookapi/hook/param/PackageParam.kt | 8 ++++---- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/api/public/HookParam.md b/docs/api/public/HookParam.md index 6ea637aa..6784209b 100644 --- a/docs/api/public/HookParam.md +++ b/docs/api/public/HookParam.md @@ -10,7 +10,7 @@ class HookParam internal constructor(private val createrInstance: YukiMemberHook **功能描述** -> Hook 方法、构造类的目标对象实现类。 +> Hook 方法、构造方法的目标对象实现类。 ### args [field] diff --git a/docs/api/public/PackageParam.md b/docs/api/public/PackageParam.md index 544b132a..e8118202 100644 --- a/docs/api/public/PackageParam.md +++ b/docs/api/public/PackageParam.md @@ -550,7 +550,7 @@ inline fun HookClass.hook(isUseAppClassLoader: Boolean, initiate: YukiMemberHook **功能描述** -> 这是一切 Hook 的入口创建方法，Hook 方法、构造类。 +> 这是一切 Hook 的入口创建方法，Hook 方法、构造方法。 **功能示例** diff --git a/docs/api/public/ReflectionFactory.md b/docs/api/public/ReflectionFactory.md index 19c7560a..7f47f62d 100644 --- a/docs/api/public/ReflectionFactory.md +++ b/docs/api/public/ReflectionFactory.md @@ -314,7 +314,7 @@ inline fun Class<*>.constructor(initiate: ConstructorFinder.() -> Unit): Constru **功能描述** -> 查找并得到构造类。 +> 查找并得到构造方法。 ### ~~callStatic [method]~~ diff --git a/docs/api/public/YukiMemberHookCreater.md b/docs/api/public/YukiMemberHookCreater.md index 0948526d..5c4933f1 100644 --- a/docs/api/public/YukiMemberHookCreater.md +++ b/docs/api/public/YukiMemberHookCreater.md @@ -96,11 +96,11 @@ inline fun injectMember(priority: Int, tag: String, initiate: MemberHookCreater. **功能描述** -> 注入要 Hook 的方法、构造类。 +> 注入要 Hook 的方法、构造方法。 **功能示例** -你可以注入任意方法与构造类，使用 `injectMember` 即可创建一个 `Hook` 对象。 +你可以注入任意方法与构造方法，使用 `injectMember` 即可创建一个 `Hook` 对象。 > 示例如下 @@ -150,7 +150,7 @@ inner class MemberHookCreater internal constructor(private val priority: Int, in **功能描述** -> Hook 核心功能实现类，查找和处理需要 Hook 的方法、构造类。 +> Hook 核心功能实现类，查找和处理需要 Hook 的方法、构造方法。 #### member [field] @@ -164,7 +164,7 @@ var member: Member? **功能描述** -> 手动指定要 Hook 的方法、构造类。 +> 手动指定要 Hook 的方法、构造方法。 !> 不建议使用此方法设置目标需要 Hook 的 `Member` 对象，你可以使用 `method` 或 `constructor` 方法。 @@ -398,7 +398,7 @@ inline fun HookParam.injectMember(priority: Int, tag: String, initiate: MemberHo **功能描述** -> 注入要 Hook 的方法、构造类 (嵌套 Hook)。 +> 注入要 Hook 的方法、构造方法 (嵌套 Hook)。 #### beforeHook [method] diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreater.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreater.kt index 30560230..ebd04feb 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreater.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreater.kt @@ -77,7 +77,7 @@ class YukiMemberHookCreater(@PublishedApi internal val packageParam: PackagePara @PublishedApi internal var isDisableCreaterRunHook = false - /** 设置要 Hook 的方法、构造类 */ + /** 设置要 Hook 的方法、构造方法 */ @PublishedApi internal var preHookMembers = HashMap() @@ -92,7 +92,7 @@ class YukiMemberHookCreater(@PublishedApi internal val packageParam: PackagePara get() = hookClass.instance ?: error("Cannot get hook class \"${hookClass.name}\" cause ${hookClass.throwable?.message}") /** - * 注入要 Hook 的方法、构造类 + * 注入要 Hook 的方法、构造方法 * @param priority Hook 优先级 - 默认 [PRIORITY_DEFAULT] * @param tag 可设置标签 - 在发生错误时方便进行调试 * @param initiate 方法体 @@ -133,7 +133,7 @@ class YukiMemberHookCreater(@PublishedApi internal val packageParam: PackagePara /** * Hook 核心功能实现类 * - * 查找和处理需要 Hook 的方法、构造类 + * 查找和处理需要 Hook 的方法、构造方法 * @param priority Hook 优先级 * @param tag 当前设置的标签 * @param packageName 当前 Hook 的 APP 包名 @@ -207,7 +207,7 @@ class YukiMemberHookCreater(@PublishedApi internal val packageParam: PackagePara private var allMethodsName = "" /** - * 手动指定要 Hook 的方法、构造类 + * 手动指定要 Hook 的方法、构造方法 * * 你可以调用 [instanceClass] 来手动查询要 Hook 的方法 */ @@ -312,7 +312,7 @@ class YukiMemberHookCreater(@PublishedApi internal val packageParam: PackagePara else ConstructorFinder(hookInstance = this@MemberHookCreater, hookClass.instance).apply(initiate).build() /** - * 注入要 Hook 的方法、构造类 (嵌套 Hook) + * 注入要 Hook 的方法、构造方法 (嵌套 Hook) * @param priority Hook 优先级 - 默认 [PRIORITY_DEFAULT] * @param tag 可设置标签 - 在发生错误时方便进行调试 * @param initiate 方法体 diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/finder/base/BaseFinder.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/finder/base/BaseFinder.kt index a31d0b24..6e19638f 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/finder/base/BaseFinder.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/core/finder/base/BaseFinder.kt @@ -137,7 +137,7 @@ abstract class BaseFinder( internal val hookTag get() = hookInstance?.tag ?: "FinderMode" /** - * 判断是否没有设置 Hook 过程中 方法、构造类、变量 找不到的任何异常拦截 + * 判断是否没有设置 Hook 过程中 方法、构造方法、变量 找不到的任何异常拦截 * @return [Boolean] 没有设置任何异常拦截 */ internal val isNotIgnoredNoSuchMemberFailure get() = hookInstance?.isNotIgnoredNoSuchMemberFailure ?: true diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt index b6fa3b50..3db7c37b 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt @@ -148,7 +148,7 @@ inline fun Class<*>.field(initiate: FieldFinder.() -> Unit) = FieldFinder(classS inline fun Class<*>.method(initiate: MethodFinder.() -> Unit) = MethodFinder(classSet = this).apply(initiate).build() /** - * 查找并得到构造类 + * 查找并得到构造方法 * @param initiate 查找方法体 * @return [ConstructorFinder.Result] */ diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/HookParam.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/HookParam.kt index fede2408..1548a5f3 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/HookParam.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/HookParam.kt @@ -36,7 +36,7 @@ import java.lang.reflect.Member import java.lang.reflect.Method /** - * Hook 方法、构造类的目标对象实现类 + * Hook 方法、构造方法的目标对象实现类 * @param createrInstance [YukiMemberHookCreater] 的实例对象 * @param wrapper [HookParam] 的参数包装类实例 */ diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/PackageParam.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/PackageParam.kt index 0bdb41a5..1a73a9d2 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/PackageParam.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/param/PackageParam.kt @@ -344,7 +344,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper: fun findClass(vararg name: String) = VariousClass(*name) /** - * Hook 方法、构造类 + * Hook 方法、构造方法 * * - ❗为防止任何字符串都被当做 [Class] 进行 Hook - 推荐优先使用 [findClass] * @param isUseAppClassLoader 是否使用 [appClassLoader] 重新绑定当前 [Class] - 默认启用 @@ -355,7 +355,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper: findClass(name = this).hook(isUseAppClassLoader, initiate) /** - * Hook 方法、构造类 + * Hook 方法、构造方法 * @param isUseAppClassLoader 是否使用 [appClassLoader] 重新绑定当前 [Class] - 默认启用 * @param initiate 方法体 * @return [YukiMemberHookCreater.Result] @@ -364,7 +364,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper: hookClass.hook(isUseAppClassLoader, initiate) /** - * Hook 方法、构造类 + * Hook 方法、构造方法 * @param isUseAppClassLoader 是否使用 [appClassLoader] 重新绑定当前 [Class] - 默认启用 * @param initiate 方法体 * @return [YukiMemberHookCreater.Result] @@ -373,7 +373,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper: hookClass(if (isUseAppClassLoader) appClassLoader else null).hook(isUseAppClassLoader, initiate) /** - * Hook 方法、构造类 + * Hook 方法、构造方法 * @param isUseAppClassLoader 是否使用 [appClassLoader] 重新绑定当前 [Class] - 默认启用 * @param initiate 方法体 * @return [YukiMemberHookCreater.Result]