docs: correct comments

This commit is contained in:
2023-09-23 19:39:10 +08:00
parent 1f1a0b6c11
commit e7cca9b5ca
35 changed files with 122 additions and 122 deletions

View File

@@ -60,7 +60,7 @@ const val API_VERSION_CODE: Int
`v1.0.91` `removed`
移到 `Status.Executor.name`
移到 `Status.Executor.name`
<h2 class="deprecated">executorVersion - field</h2>
@@ -70,7 +70,7 @@ const val API_VERSION_CODE: Int
`v1.0.91` `removed`
移到 `Status.Executor.apiLevel`、`Status.Executor.versionName`、`Status.Executor.versionCode`
移到 `Status.Executor.apiLevel`、`Status.Executor.versionName`、`Status.Executor.versionCode`
## Status <span class="symbol">- object</span>
@@ -122,7 +122,7 @@ val isXposedEnvironment: Boolean
`v1.1.5` `deprecated`
移到 `Executor.name`
移到 `Executor.name`
<h3 class="deprecated">executorVersion - field</h3>
@@ -132,7 +132,7 @@ val isXposedEnvironment: Boolean
`v1.1.5` `deprecated`
移到 `Executor.apiLevel`、`Executor.versionName`、`Executor.versionCode`
移到 `Executor.apiLevel`、`Executor.versionName`、`Executor.versionCode`
### isModuleActive <span class="symbol">- field</span>
@@ -376,7 +376,7 @@ inline fun debugLog(initiate: YukiHookLogger.Configs.() -> Unit)
`v1.1.0` `deprecated`
移到 `YukiHookLogger.Configs.tag`
移到 `YukiHookLogger.Configs.tag`
### isDebug <span class="symbol">- field</span>
@@ -402,7 +402,7 @@ var isDebug: Boolean
`v1.1.0` `deprecated`
移到 `YukiHookLogger.Configs.isEnable`
移到 `YukiHookLogger.Configs.isEnable`
<h3 class="deprecated">isEnableModulePrefsCache - field</h3>
@@ -412,7 +412,7 @@ var isDebug: Boolean
`v1.1.9` `deprecated`
移到 `isEnablePrefsBridgeCache`
移到 `isEnablePrefsBridgeCache`
<h3 class="deprecated">isEnablePrefsBridgeCache - field</h3>

View File

@@ -216,7 +216,7 @@ inner class MemberHookCreator internal constructor(private val priority: Int, in
`v1.1.0` `removed`
移到 `members`
移到 `members`
### members <span class="symbol">- method</span>

View File

@@ -743,7 +743,7 @@ fun ignored(): Result
`v1.1.0` `deprecated`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -602,7 +602,7 @@ fun ignored(): Result
`v1.1.0` `deprecated`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -873,7 +873,7 @@ fun ignored(): Result
`v1.1.0` `deprecated`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -904,7 +904,7 @@ inline fun <reified T : Any> T.current(ignored: Boolean, initiate: CurrentClass.
`v1.1.0` `deprecated`
移到 `buildOf` 方法
移到 `buildOf` 方法
## Class.buildOf <span class="symbol">- ext-method</span>

View File

@@ -72,7 +72,7 @@ fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker)
`v1.1.9` `deprecated`
移到 `prefs` 方法
移到 `prefs` 方法
<h2 class="deprecated">Context.modulePrefs - ext-method</h2>
@@ -82,7 +82,7 @@ fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker)
`v1.1.9` `deprecated`
移到 `prefs` 方法
移到 `prefs` 方法
## Context.prefs <span class="symbol">- ext-method</span>
@@ -224,7 +224,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `removed`
移到 `YukiHookAPI.Status.isSupportResourcesHook`
移到 `YukiHookAPI.Status.isSupportResourcesHook`
<h2 class="deprecated">isModuleActive - field</h2>
@@ -234,7 +234,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `removed`
移到 `YukiHookAPI.Status.isModuleActive`
移到 `YukiHookAPI.Status.isModuleActive`
<h2 class="deprecated">isXposedModuleActive - field</h2>
@@ -244,7 +244,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `removed`
移到 `YukiHookAPI.Status.isXposedModuleActive`
移到 `YukiHookAPI.Status.isXposedModuleActive`
<h2 class="deprecated">isTaiChiModuleActive - field</h2>
@@ -254,7 +254,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `removed`
移到 `YukiHookAPI.Status.isTaiChiModuleActive`
移到 `YukiHookAPI.Status.isTaiChiModuleActive`
<h1 class="deprecated">YukiHookModuleStatus - class</h1>
@@ -264,4 +264,4 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `deprecated`
移到 `YukiHookAPI.Status`
移到 `YukiHookAPI.Status`

View File

@@ -58,7 +58,7 @@ LOGD
`v1.1.5` `deprecated`
移到 `XPOSED_ENVIRONMENT`
移到 `XPOSED_ENVIRONMENT`
### XPOSED_ENVIRONMENT <span class="symbol">- enum</span>

View File

@@ -617,7 +617,7 @@ inline fun searchClass(name: String, async: Boolean, initiate: ClassConditions):
`v1.1.0` `deprecated`
移到 `toClass(...)` 方法
移到 `toClass(...)` 方法
<h2 class="deprecated">String.hasClass - i-ext-field</h2>
@@ -627,7 +627,7 @@ inline fun searchClass(name: String, async: Boolean, initiate: ClassConditions):
`v1.1.0` `deprecated`
移到 `hasClass(...)` 方法
移到 `hasClass(...)` 方法
## String+VariousClass.toClass <span class="symbol">- i-ext-method</span>

View File

@@ -70,7 +70,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context?)
`v1.1.5` `deprecated`
移到 `isPreferencesAvailable`
移到 `isPreferencesAvailable`
<h2 class="deprecated">isRunInNewXShareMode - field</h2>
@@ -80,7 +80,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context?)
`v1.1.5` `deprecated`
移到 `isPreferencesAvailable`
移到 `isPreferencesAvailable`
## isPreferencesAvailable <span class="symbol">- field</span>
@@ -286,7 +286,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">clear - method</h2>
@@ -296,7 +296,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putString - method</h2>
@@ -306,7 +306,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putStringSet - method</h2>
@@ -316,7 +316,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putBoolean - method</h2>
@@ -326,7 +326,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putInt - method</h2>
@@ -336,7 +336,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putLong - method</h2>
@@ -346,7 +346,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putFloat - method</h2>
@@ -356,7 +356,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
## get <span class="symbol">- method</span>
@@ -380,7 +380,7 @@ inline fun <reified T> get(prefs: PrefsData<T>, value: T): T
`v1.1.9` `deprecated`
移到 `edit` 方法
移到 `edit` 方法
## edit <span class="symbol">- method</span>

View File

@@ -24,7 +24,7 @@ interface IYukiHookXposedInit
作废了 ~~`YukiHookXposedInitProxy`~~ 名称但保留接口
移到 `IYukiHookXposedInit` 新名称
移到 `IYukiHookXposedInit` 新名称
**Function Illustrate**
@@ -106,4 +106,4 @@ fun onXposedEvent()
`v1.0.80` `deprecated`
移到 `IYukiHookXposedInit`
移到 `IYukiHookXposedInit`

View File

@@ -38,7 +38,7 @@
- 新增 `ExecutorType`,可以通过 `YukiHookAPI.Status.Executor.type` 来获取已知 Hook Framework 的类型
- ~~`YukiHookModulePrefs`~~ 更名为 `YukiHookPrefsBridge`
- 修改 `YukiHookPrefsBridge` 为非单例实现,作为单例可能发生数据混淆的问题
- 作废了 ~~`Context.modulePrefs(...)`~~ 方法,请移到 `Context.prefs(...)`
- 作废了 ~~`Context.modulePrefs(...)`~~ 方法,请移到 `Context.prefs(...)`
- `YukiHookPrefsBridge` 新增 `native` 方法,支持直接作为原生存储在模块和宿主中存储私有数据
- 整合 `YukiHookPrefsBridge` 中的存储方法到 `YukiHookPrefsBridge.Editor`,请使用 `edit` 方法来存储数据
- `YukiHookPrefsBridge` 新增 `contains` 方法
@@ -88,7 +88,7 @@
- 修复一个 Hook 过程中方法返回值的对象是目标的继承类和接口时被识别为返回值不符的严重错误
- 修复在当前 Hook 的实例对象是静态的情况下调用 `HookParam.callOriginal``HookParam.invokeOriginal` 出现对象为空问题
- 优化对太极激活方法相关判断功能以及同步更新文档相关说明
- 作废了 ~~`YukiHookAPI.Status.executorName`~~、~~`YukiHookAPI.Status.executorVersion`~~,请移到 `YukiHookAPI.Status.Executor`
- 作废了 ~~`YukiHookAPI.Status.executorName`~~、~~`YukiHookAPI.Status.executorVersion`~~,请移到 `YukiHookAPI.Status.Executor`
- 适配了一些第三方 Hook Framework 的 `YukiHookAPI.Status.Executor.name` 名称显示功能
- 新增 `Class.extends``Class.implements` 等方法,可更加方便地判断当前 `Class` 的继承与接口关系
- 新增 `Class.toClass``Class.toClassOrNull` 等相关方法的同名泛型方法,可使用泛型来约束已知 `Class` 的实例对象类型
@@ -193,7 +193,7 @@
- 新增模块资源注入与 `Activity` 代理功能,你可以调用 `injectModuleAppResources``registerModuleAppActivities` 来使用
- 新增 `ModuleContextThemeWrapper` 功能,你可以调用 `applyModuleTheme` 在任意 `Activity` 中创建模块的 `Context`
- 新增 `ClassLoader.onLoadClass` 功能,可用于监听 `ClassLoader``loadClass` 方法被调用的事件
- 作废了 `classOf``clazz` 扩展方法,新增 `toClass` 以及 `toClassOrNull` 用法,请现在移到新的方法
- 作废了 `classOf``clazz` 扩展方法,新增 `toClass` 以及 `toClassOrNull` 用法,请现在移到新的方法
- `VariousClass` 新增 `getOrNull` 方法,可在匹配不到 `Class` 的时候不抛出异常而是返回 `null`
- `PackageParam.hook` 中移除了 `isUseAppClassLoader` 参数,修改为 `isForceUseAbsolute` 并自动匹配目标 `Class`
- `PackageParam` 新增 `systemContext` 功能,你可以在任意时间调用此功能获取一个持久化的 `Context`

View File

@@ -52,7 +52,7 @@ const val API_VERSION_CODE: Int
`v1.0.91` `移除`
移到 `Status.Executor.name`
移到 `Status.Executor.name`
<h2 class="deprecated">executorVersion - field</h2>
@@ -62,7 +62,7 @@ const val API_VERSION_CODE: Int
`v1.0.91` `移除`
移到 `Status.Executor.apiLevel`、`Status.Executor.versionName`、`Status.Executor.versionCode`
移到 `Status.Executor.apiLevel`、`Status.Executor.versionName`、`Status.Executor.versionCode`
## Status <span class="symbol">- object</span>
@@ -114,7 +114,7 @@ val isXposedEnvironment: Boolean
`v1.1.5` `作废`
移到 `Executor.name`
移到 `Executor.name`
<h3 class="deprecated">executorVersion - field</h3>
@@ -124,7 +124,7 @@ val isXposedEnvironment: Boolean
`v1.1.5` `作废`
移到 `Executor.apiLevel`、`Executor.versionName`、`Executor.versionCode`
移到 `Executor.apiLevel`、`Executor.versionName`、`Executor.versionCode`
### isModuleActive <span class="symbol">- field</span>
@@ -368,7 +368,7 @@ inline fun debugLog(initiate: YukiHookLogger.Configs.() -> Unit)
`v1.1.0` `作废`
移到 `YukiHookLogger.Configs.tag`
移到 `YukiHookLogger.Configs.tag`
### isDebug <span class="symbol">- field</span>
@@ -394,7 +394,7 @@ var isDebug: Boolean
`v1.1.0` `作废`
移到 `YukiHookLogger.Configs.isEnable`
移到 `YukiHookLogger.Configs.isEnable`
<h3 class="deprecated">isEnableModulePrefsCache - field</h3>
@@ -404,7 +404,7 @@ var isDebug: Boolean
`v1.1.9` `作废`
移到 `isEnablePrefsBridgeCache`
移到 `isEnablePrefsBridgeCache`
<h3 class="deprecated">isEnablePrefsBridgeCache - field</h3>

View File

@@ -208,7 +208,7 @@ inner class MemberHookCreator internal constructor(private val priority: Int, in
`v1.1.0` `移除`
移到 `members`
移到 `members`
### members <span class="symbol">- method</span>

View File

@@ -735,7 +735,7 @@ fun ignored(): Result
`v1.1.0` `作废`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -594,7 +594,7 @@ fun ignored(): Result
`v1.1.0` `作废`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -865,7 +865,7 @@ fun ignored(): Result
`v1.1.0` `作废`
移到新方法 `ignored()`
移到新方法 `ignored()`
### Instance <span class="symbol">- class</span>

View File

@@ -896,7 +896,7 @@ inline fun <reified T : Any> T.current(ignored: Boolean, initiate: CurrentClass.
`v1.1.0` `作废`
移到 `buildOf` 方法
移到 `buildOf` 方法
## Class.buildOf <span class="symbol">- ext-method</span>

View File

@@ -64,7 +64,7 @@ fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker)
`v1.1.9` `作废`
移到 `prefs` 方法
移到 `prefs` 方法
<h2 class="deprecated">Context.modulePrefs - ext-method</h2>
@@ -74,7 +74,7 @@ fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker)
`v1.1.9` `作废`
移到 `prefs` 方法
移到 `prefs` 方法
## Context.prefs <span class="symbol">- ext-method</span>
@@ -216,7 +216,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `移除`
移到 `YukiHookAPI.Status.isSupportResourcesHook`
移到 `YukiHookAPI.Status.isSupportResourcesHook`
<h2 class="deprecated">isModuleActive - field</h2>
@@ -226,7 +226,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `移除`
移到 `YukiHookAPI.Status.isModuleActive`
移到 `YukiHookAPI.Status.isModuleActive`
<h2 class="deprecated">isXposedModuleActive - field</h2>
@@ -236,7 +236,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `移除`
移到 `YukiHookAPI.Status.isXposedModuleActive`
移到 `YukiHookAPI.Status.isXposedModuleActive`
<h2 class="deprecated">isTaiChiModuleActive - field</h2>
@@ -246,7 +246,7 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `移除`
移到 `YukiHookAPI.Status.isTaiChiModuleActive`
移到 `YukiHookAPI.Status.isTaiChiModuleActive`
<h1 class="deprecated">YukiHookModuleStatus - class</h1>
@@ -256,4 +256,4 @@ fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleC
`v1.0.91` `作废`
移到 `YukiHookAPI.Status`
移到 `YukiHookAPI.Status`

View File

@@ -50,7 +50,7 @@ LOGD
`v1.1.5` `作废`
移到 `XPOSED_ENVIRONMENT`
移到 `XPOSED_ENVIRONMENT`
### XPOSED_ENVIRONMENT <span class="symbol">- enum</span>

View File

@@ -609,7 +609,7 @@ inline fun searchClass(name: String, async: Boolean, initiate: ClassConditions):
`v1.1.0` `作废`
移到 `toClass(...)` 方法
移到 `toClass(...)` 方法
<h2 class="deprecated">String.hasClass - i-ext-field</h2>
@@ -619,7 +619,7 @@ inline fun searchClass(name: String, async: Boolean, initiate: ClassConditions):
`v1.1.0` `作废`
移到 `hasClass(...)` 方法
移到 `hasClass(...)` 方法
## String+VariousClass.toClass <span class="symbol">- i-ext-method</span>

View File

@@ -62,7 +62,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context?)
`v1.1.5` `作废`
移到 `isPreferencesAvailable`
移到 `isPreferencesAvailable`
<h2 class="deprecated">isRunInNewXShareMode - field</h2>
@@ -72,7 +72,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context?)
`v1.1.5` `作废`
移到 `isPreferencesAvailable`
移到 `isPreferencesAvailable`
## isPreferencesAvailable <span class="symbol">- field</span>
@@ -278,7 +278,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">clear - method</h2>
@@ -288,7 +288,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putString - method</h2>
@@ -298,7 +298,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putStringSet - method</h2>
@@ -308,7 +308,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putBoolean - method</h2>
@@ -318,7 +318,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putInt - method</h2>
@@ -328,7 +328,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putLong - method</h2>
@@ -338,7 +338,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
<h2 class="deprecated">putFloat - method</h2>
@@ -348,7 +348,7 @@ fun all(): HashMap<String, Any?>
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
## get <span class="symbol">- method</span>
@@ -372,7 +372,7 @@ inline fun <reified T> get(prefs: PrefsData<T>, value: T): T
`v1.1.9` `作废`
移到 `edit` 方法
移到 `edit` 方法
## edit <span class="symbol">- method</span>

View File

@@ -16,7 +16,7 @@ interface IYukiHookXposedInit
作废了 ~~`YukiHookXposedInitProxy`~~ 名称但保留接口
移到 `IYukiHookXposedInit` 新名称
移到 `IYukiHookXposedInit` 新名称
**功能描述**
@@ -98,4 +98,4 @@ fun onXposedEvent()
`v1.0.80` `作废`
移到 `IYukiHookXposedInit`
移到 `IYukiHookXposedInit`