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

Modify merge to new document url for code note

Browse Source
This commit is contained in:
fankesyooni
2022-09-17 14:54:52 +08:00
parent 8f73935a3f
commit 2bd3acf73b
11 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
yukihookapi-ksp-xposed/src/api/kotlin/com/highcapable/yukihookapi_ksp_xposed/YukiHookXposedProcessor.kt
View File

@@ -81,7 +81,7 @@ class YukiHookXposedProcessor : SymbolProcessorProvider {
* @param msg 错误消息 * @param msg 错误消息
*/ */
private fun SymbolProcessorEnvironment.problem(msg: String) { private fun SymbolProcessorEnvironment.problem(msg: String) {
val helpMsg = "Looking for help? see https://fankes.github.io/YukiHookAPI/#/config/xposed-using" val helpMsg = "Looking for help? see https://fankes.github.io/YukiHookAPI/en/config/xposed-using"
logger.error(message = "[$TAG] $msg\n$helpMsg") logger.error(message = "[$TAG] $msg\n$helpMsg")
throw RuntimeException("[$TAG] $msg\n$helpMsg") throw RuntimeException("[$TAG] $msg\n$helpMsg")
} }

24
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt
View File

@@ -259,7 +259,7 @@ object YukiHookAPI {
* *
* 推荐使用 [MethodFinder]、[ConstructorFinder]、[FieldFinder] 来获取 [Member] * 推荐使用 [MethodFinder]、[ConstructorFinder]、[FieldFinder] 来获取 [Member]
* *
* 详情请参考 [API 文档](https://fankes.github.io/YukiHookAPI/#/api/home) * 详情请参考 [API 文档](https://fankes.github.io/YukiHookAPI/zh-cn/api/home)
* *
* 除非缓存的 [Member] 发生了混淆的问题 - 例如使用 R8 混淆后的 APP 的目标 [Member] - 否则建议启用 * 除非缓存的 [Member] 发生了混淆的问题 - 例如使用 R8 混淆后的 APP 的目标 [Member] - 否则建议启用
*/ */
@@ -280,7 +280,7 @@ object YukiHookAPI {
/** /**
* 配置 [YukiHookAPI] 相关参数 * 配置 [YukiHookAPI] 相关参数
* *
* 详情请参考 [configs 方法](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=configs-%e6%96%b9%e6%b3%95) * 详情请参考 [configs 方法](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#configs-%E6%96%B9%E6%B3%95)
* @param initiate 方法体 * @param initiate 方法体
*/ */
inline fun configs(initiate: Configs.() -> Unit) = Configs.apply(initiate).build() inline fun configs(initiate: Configs.() -> Unit) = Configs.apply(initiate).build()
@@ -288,9 +288,9 @@ object YukiHookAPI {
/** /**
* 作为模块装载调用入口方法 - Xposed API * 作为模块装载调用入口方法 - Xposed API
* *
* 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/#/api/home) * 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/zh-cn/api/home)
* *
* 配置请参考 [通过 Lambda 创建](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=%e9%80%9a%e8%bf%87-lambda-%e5%88%9b%e5%bb%ba) * 配置请参考 [通过 lambda 创建](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#%E9%80%9A%E8%BF%87-lambda-%E5%88%9B%E5%BB%BA)
* @param initiate Hook 方法体 * @param initiate Hook 方法体
*/ */
fun encase(initiate: PackageParam.() -> Unit) { fun encase(initiate: PackageParam.() -> Unit) {
@@ -303,9 +303,9 @@ object YukiHookAPI {
/** /**
* 作为模块装载调用入口方法 - Xposed API * 作为模块装载调用入口方法 - Xposed API
* *
* 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/#/api/home) * 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/zh-cn/api/home)
* *
* 配置请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=%e9%80%9a%e8%bf%87%e8%87%aa%e5%ae%9a%e4%b9%89-hooker-%e5%88%9b%e5%bb%ba) * 配置请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#%E9%80%9A%E8%BF%87%E8%87%AA%E5%AE%9A%E4%B9%89-hooker-%E5%88%9B%E5%BB%BA)
* @param hooker Hook 子类数组 - 必填不能为空 * @param hooker Hook 子类数组 - 必填不能为空
* @throws IllegalStateException 如果 [hooker] 是空的 * @throws IllegalStateException 如果 [hooker] 是空的
*/ */
@@ -325,11 +325,11 @@ object YukiHookAPI {
* *
* 请在 [Application.attachBaseContext] 中实现 [YukiHookAPI] 的装载 * 请在 [Application.attachBaseContext] 中实现 [YukiHookAPI] 的装载
* *
* 详情请参考 [作为 Hook API 使用](https://fankes.github.io/YukiHookAPI/#/guide/quick-start?id=%e4%bd%9c%e4%b8%ba-hook-api-%e4%bd%bf%e7%94%a8) * 详情请参考 [作为 Hook API 使用](https://fankes.github.io/YukiHookAPI/zh-cn/guide/quick-start#%E4%BD%9C%E4%B8%BA-hook-api-%E4%BD%BF%E7%94%A8)
* *
* 配置请参考 [通过 Lambda 创建](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=%e9%80%9a%e8%bf%87-lambda-%e5%88%9b%e5%bb%ba) * 配置请参考 [通过 lambda 创建](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#%E9%80%9A%E8%BF%87-lambda-%E5%88%9B%E5%BB%BA)
* *
* 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/#/api/home) * 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/zh-cn/api/home)
* @param baseContext attachBaseContext * @param baseContext attachBaseContext
* @param initiate Hook 方法体 * @param initiate Hook 方法体
*/ */
@@ -346,11 +346,11 @@ object YukiHookAPI {
* *
* 请在 [Application.attachBaseContext] 中实现 [YukiHookAPI] 的装载 * 请在 [Application.attachBaseContext] 中实现 [YukiHookAPI] 的装载
* *
* 详情请参考 [作为 Hook API 使用](https://fankes.github.io/YukiHookAPI/#/guide/quick-start?id=%e4%bd%9c%e4%b8%ba-hook-api-%e4%bd%bf%e7%94%a8) * 详情请参考 [作为 Hook API 使用](https://fankes.github.io/YukiHookAPI/zh-cn/guide/quick-start#%E4%BD%9C%E4%B8%BA-hook-api-%E4%BD%BF%E7%94%A8)
* *
* 配置请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=%e9%80%9a%e8%bf%87%e8%87%aa%e5%ae%9a%e4%b9%89-hooker-%e5%88%9b%e5%bb%ba) * 配置请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#%E9%80%9A%E8%BF%87%E8%87%AA%E5%AE%9A%E4%B9%89-hooker-%E5%88%9B%E5%BB%BA)
* *
* 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/#/api/home) * 用法请参考 [API 文档](https://fankes.github.io/YukiHookAPI/zh-cn/api/home)
* @param baseContext attachBaseContext * @param baseContext attachBaseContext
* @param hooker Hook 子类数组 - 必填不能为空 * @param hooker Hook 子类数组 - 必填不能为空
* @throws IllegalStateException 如果 [hooker] 是空的 * @throws IllegalStateException 如果 [hooker] 是空的

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.kt
View File

@@ -50,7 +50,7 @@ import de.robv.android.xposed.IXposedHookInitPackageResources
* *
* - ❗只能拥有一个 Hook 入口 - 若存在多个注解编译会报错 * - ❗只能拥有一个 Hook 入口 - 若存在多个注解编译会报错
* *
* 详情请参考 [InjectYukiHookWithXposed 注解](https://fankes.github.io/YukiHookAPI/#/config/xposed-using?id=injectyukihookwithxposed-%e6%b3%a8%e8%a7%a3) * 详情请参考 [InjectYukiHookWithXposed 注解](https://fankes.github.io/YukiHookAPI/zh-cn/config/xposed-using#injectyukihookwithxposed-%E6%B3%A8%E8%A7%A3)
* @param sourcePath 你的项目 source 相对路径 - 默认为 ..src/main.. * @param sourcePath 你的项目 source 相对路径 - 默认为 ..src/main..
* @param modulePackageName 模块包名 - 不填默认自动生成 * @param modulePackageName 模块包名 - 不填默认自动生成
* @param entryClassName 定义 [YukiHookAPI] 自动生成 Xposed 模块入口类的名称 - 不填默认使用 HookEntryClass_YukiHookXposedInit 进行生成 * @param entryClassName 定义 [YukiHookAPI] 自动生成 Xposed 模块入口类的名称 - 不填默认使用 HookEntryClass_YukiHookXposedInit 进行生成

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/entity/YukiBaseHooker.kt
View File

@@ -55,7 +55,7 @@ import com.highcapable.yukihookapi.hook.xposed.proxy.IYukiHookXposedInit
* *
* 更多请参考 [InjectYukiHookWithXposed] 中的注解内容 * 更多请参考 [InjectYukiHookWithXposed] 中的注解内容
* *
* 详情请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/#/config/api-example?id=%e9%80%9a%e8%bf%87%e8%87%aa%e5%ae%9a%e4%b9%89-hooker-%e5%88%9b%e5%bb%ba) * 详情请参考 [通过自定义 Hooker 创建](https://fankes.github.io/YukiHookAPI/zh-cn/config/api-example#%E9%80%9A%E8%BF%87%E8%87%AA%E5%AE%9A%E4%B9%89-hooker-%E5%88%9B%E5%BB%BA)
*/ */
abstract class YukiBaseHooker : PackageParam() { abstract class YukiBaseHooker : PackageParam() {

8
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/factory/YukiHookFactory.kt
View File

@@ -116,7 +116,7 @@ val Context.processName
* *
* 注入的资源作用域仅限当前 [Context] - 你需要在每个用到宿主 [Context] 的地方重复调用此方法进行注入才能使用 * 注入的资源作用域仅限当前 [Context] - 你需要在每个用到宿主 [Context] 的地方重复调用此方法进行注入才能使用
* *
* 详情请参考 [注入模块资源 (Resources)](https://fankes.github.io/YukiHookAPI/#/guide/special-feature?id=%e6%b3%a8%e5%85%a5%e6%a8%a1%e5%9d%97%e8%b5%84%e6%ba%90-resources) * 详情请参考 [注入模块资源 (Resources)](https://fankes.github.io/YukiHookAPI/zh-cn/api/special-features/host-inject#%E6%B3%A8%E5%85%A5%E6%A8%A1%E5%9D%97%E8%B5%84%E6%BA%90-resources)
* *
* - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息 * - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息
*/ */
@@ -129,7 +129,7 @@ fun Context.injectModuleAppResources() = resources?.injectModuleAppResources()
* *
* 注入的资源作用域仅限当前 [Resources] - 你需要在每个用到宿主 [Resources] 的地方重复调用此方法进行注入才能使用 * 注入的资源作用域仅限当前 [Resources] - 你需要在每个用到宿主 [Resources] 的地方重复调用此方法进行注入才能使用
* *
* 详情请参考 [注入模块资源 (Resources)](https://fankes.github.io/YukiHookAPI/#/guide/special-feature?id=%e6%b3%a8%e5%85%a5%e6%a8%a1%e5%9d%97%e8%b5%84%e6%ba%90-resources) * 详情请参考 [注入模块资源 (Resources)](https://fankes.github.io/YukiHookAPI/zh-cn/api/special-features/host-inject#%E6%B3%A8%E5%85%A5%E6%A8%A1%E5%9D%97%E8%B5%84%E6%BA%90-resources)
* *
* - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息 * - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息
*/ */
@@ -144,7 +144,7 @@ fun Resources.injectModuleAppResources() = AppParasitics.injectModuleAppResource
* *
* - 你要将需要在宿主启动的 [Activity] 继承于 [ModuleAppActivity] 或 [ModuleAppCompatActivity] * - 你要将需要在宿主启动的 [Activity] 继承于 [ModuleAppActivity] 或 [ModuleAppCompatActivity]
* *
* 详情请参考 [注册模块 Activity](https://fankes.github.io/YukiHookAPI/#/guide/special-feature?id=%e6%b3%a8%e5%86%8c%e6%a8%a1%e5%9d%97-activity) * 详情请参考 [注册模块 Activity](https://fankes.github.io/YukiHookAPI/zh-cn/api/special-features/host-inject#%E6%B3%A8%E5%86%8C%E6%A8%A1%E5%9D%97-activity)
* *
* - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息 * - ❗只能在 (Xposed) 宿主环境使用此功能 - 其它环境下使用将不生效且会打印警告信息
* @param proxy 代理的 [Activity] - 必须存在于宿主的 AndroidMainifest 清单中 - 不填使用默认 [Activity] * @param proxy 代理的 [Activity] - 必须存在于宿主的 AndroidMainifest 清单中 - 不填使用默认 [Activity]
@@ -158,7 +158,7 @@ fun Context.registerModuleAppActivities(proxy: Any? = null) = AppParasitics.regi
* *
* - 如果在 Hook APP (宿主) 中使用此方法发生 [ClassCastException] - 请手动设置新的 [configuration] * - 如果在 Hook APP (宿主) 中使用此方法发生 [ClassCastException] - 请手动设置新的 [configuration]
* *
* 详情请参考 [创建 ContextThemeWrapper 代理](https://fankes.github.io/YukiHookAPI/#/guide/special-feature?id=%e5%88%9b%e5%bb%ba-contextthemewrapper-%e4%bb%a3%e7%90%86) * 详情请参考 [创建 ContextThemeWrapper 代理](https://fankes.github.io/YukiHookAPI/zh-cn/api/special-features/host-inject#%E5%88%9B%E5%BB%BA-contextthemewrapper-%E4%BB%A3%E7%90%86)
* @param theme 主题资源 ID * @param theme 主题资源 ID
* @param configuration 使用的 [Configuration] - 默认空 * @param configuration 使用的 [Configuration] - 默认空
* @return [ModuleContextThemeWrapper] * @return [ModuleContextThemeWrapper]

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/application/ModuleApplication.kt
View File

@@ -55,7 +55,7 @@ import com.highcapable.yukihookapi.thirdparty.me.weishu.reflection.Reflection
* *
* - 在模块中使用 [YukiHookAPI.Status.isTaiChiModuleActive] 判断太极、无极激活状态 * - 在模块中使用 [YukiHookAPI.Status.isTaiChiModuleActive] 判断太极、无极激活状态
* *
* 详情请参考 [API 文档 - ModuleApplication](https://fankes.github.io/YukiHookAPI/#/api/document?id=moduleapplication-class) * 详情请参考 [API 文档 - ModuleApplication](https://fankes.github.io/YukiHookAPI/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/application/ModuleApplication)
*/ */
open class ModuleApplication : Application() { open class ModuleApplication : Application() {

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/bridge/status/YukiHookModuleStatus.kt
View File

@@ -47,7 +47,7 @@ import de.robv.android.xposed.XposedBridge
* *
* 调用 [YukiHookAPI.Status.executorVersion] 来获取当前 Hook 框架的版本 * 调用 [YukiHookAPI.Status.executorVersion] 来获取当前 Hook 框架的版本
* *
* 详情请参考 [Xposed 模块判断自身激活状态](https://fankes.github.io/YukiHookAPI/#/guide/example?id=xposed-%e6%a8%a1%e5%9d%97%e5%88%a4%e6%96%ad%e8%87%aa%e8%ba%ab%e6%bf%80%e6%b4%bb%e7%8a%b6%e6%80%81) * 详情请参考 [Xposed 模块判断自身激活状态](https://fankes.github.io/YukiHookAPI/zh-cn/guide/example#xposed-%E6%A8%A1%E5%9D%97%E5%88%A4%E6%96%AD%E8%87%AA%E8%BA%AB%E6%BF%80%E6%B4%BB%E7%8A%B6%E6%80%81)
*/ */
internal object YukiHookModuleStatus { internal object YukiHookModuleStatus {

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/channel/YukiHookDataChannel.kt
View File

@@ -58,7 +58,7 @@ import java.util.concurrent.ConcurrentHashMap
* *
* - ❗模块与宿主需要保持存活状态 - 否则无法建立通讯 * - ❗模块与宿主需要保持存活状态 - 否则无法建立通讯
* *
* - 详情请参考 [API 文档 - YukiHookDataChannel](https://fankes.github.io/YukiHookAPI/#/api/document?id=yukihookdatachannel-class) * - 详情请参考 [API 文档 - YukiHookDataChannel](https://fankes.github.io/YukiHookAPI/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/channel/YukiHookDataChannel)
*/ */
class YukiHookDataChannel private constructor() { class YukiHookDataChannel private constructor() {

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/channel/data/ChannelData.kt
View File

@@ -34,7 +34,7 @@ import com.highcapable.yukihookapi.hook.xposed.channel.YukiHookDataChannel
* *
* 这个类是对 [YukiHookDataChannel] 的一个扩展用法 * 这个类是对 [YukiHookDataChannel] 的一个扩展用法
* *
* - 详情请参考 [API 文档 - ChannelData](https://fankes.github.io/YukiHookAPI/#/api/document?id=channeldata-class) * - 详情请参考 [API 文档 - ChannelData](https://fankes.github.io/YukiHookAPI/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/channel/data/ChannelData)
* @param key 键值 * @param key 键值
* @param value 键值数据 - 作为接收数据时可空 * @param value 键值数据 - 作为接收数据时可空
*/ */

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/prefs/data/PrefsData.kt
View File

@@ -34,7 +34,7 @@ import com.highcapable.yukihookapi.hook.xposed.prefs.YukiHookModulePrefs
* *
* 这个类是对 [YukiHookModulePrefs] 的一个扩展用法 * 这个类是对 [YukiHookModulePrefs] 的一个扩展用法
* *
* - 详情请参考 [API 文档 - PrefsData](https://fankes.github.io/YukiHookAPI/#/api/document?id=prefsdata-class) * - 详情请参考 [API 文档 - PrefsData](https://fankes.github.io/YukiHookAPI/zh-cn/api/public/com/highcapable/yukihookapi/hook/xposed/prefs/data/PrefsData)
* @param key 键值 * @param key 键值
* @param value 默认值 * @param value 默认值
*/ */

2
yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/proxy/IYukiHookXposedInit.kt
View File

@@ -51,7 +51,7 @@ import com.highcapable.yukihookapi.hook.xposed.bridge.event.YukiXposedEvent
* *
* 你还可以实现监听原生 Xposed API 功能 - 重写 [onXposedEvent] 方法即可 * 你还可以实现监听原生 Xposed API 功能 - 重写 [onXposedEvent] 方法即可
* *
* 详情请参考 [IYukiHookXposedInit 接口](https://fankes.github.io/YukiHookAPI/#/config/xposed-using?id=iyukihookxposedinit-%e6%8e%a5%e5%8f%a3) * 详情请参考 [IYukiHookXposedInit 接口](https://fankes.github.io/YukiHookAPI/zh-cn/config/xposed-using#iyukihookxposedinit-%E6%8E%A5%E5%8F%A3)
*/ */
interface IYukiHookXposedInit { interface IYukiHookXposedInit {