docs: correct comments

2025-09-04 09:45:19 +08:00 · 2023-09-23 19:39:10 +08:00
parent 1f1a0b6c11
commit e7cca9b5ca
35 changed files with 122 additions and 122 deletions
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/YukiHookAPI.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/YukiHookAPI.kt
@@ -102,7 +102,7 @@ object YukiHookAPI {
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [Executor.name]
+         * - ❗请现在迁移到 [Executor.name]
         * @return [String]
         */
        @Deprecated(
@@ -116,7 +116,7 @@ object YukiHookAPI {
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [Executor.apiLevel]、[Executor.versionName]、[Executor.versionCode]
+         * - ❗请现在迁移到 [Executor.apiLevel]、[Executor.versionName]、[Executor.versionCode]
         * @return [Int]
         */
        @Deprecated(
@@ -238,7 +238,7 @@ object YukiHookAPI {
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [debugLog] 并使用 [YukiHookLogger.Configs.tag]
+         * - ❗请现在迁移到 [debugLog] 并使用 [YukiHookLogger.Configs.tag]
         */
        @Deprecated(message = "请使用新方式来实现此功能")
        var debugTag
@@ -265,7 +265,7 @@ object YukiHookAPI {
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [debugLog] 并使用 [YukiHookLogger.Configs.isEnable]
+         * - ❗请现在迁移到 [debugLog] 并使用 [YukiHookLogger.Configs.isEnable]
         */
        @Deprecated(message = "请使用新方式来实现此功能")
        var isAllowPrintingLogs
@@ -279,7 +279,7 @@ object YukiHookAPI {
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [isEnablePrefsBridgeCache]
+         * - ❗请现在迁移到 [isEnablePrefsBridgeCache]
         */
        @Deprecated(message = "请使用新的命名方法来实现此功能", ReplaceWith("isEnablePrefsBridgeCache"))
        var isEnableModulePrefsCache = false
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/YukiMemberHookCreator.kt
@@ -336,7 +336,7 @@ class YukiMemberHookCreator @PublishedApi internal constructor(
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [MethodFinder] or [allMembers]
+         * - ❗请现在迁移到 [MethodFinder] or [allMembers]
         * @param name 方法名称
         * @return [ArrayList]<[MethodFinder.Result.Instance]>
         */
@@ -348,7 +348,7 @@ class YukiMemberHookCreator @PublishedApi internal constructor(
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [ConstructorFinder] or [allMembers]
+         * - ❗请现在迁移到 [ConstructorFinder] or [allMembers]
         * @return [ArrayList]<[ConstructorFinder.Result.Instance]>
         */
        @Deprecated(
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/ConstructorFinder.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/ConstructorFinder.kt
@@ -570,7 +570,7 @@ class ConstructorFinder @PublishedApi internal constructor(@PublishedApi overrid
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [ignored]
+         * - ❗请现在迁移到 [ignored]
         * @return [Result] 可继续向下监听
         */
        @Deprecated(message = "请使用新的命名方法", ReplaceWith("ignored()"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/FieldFinder.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/FieldFinder.kt
@@ -473,7 +473,7 @@ class FieldFinder @PublishedApi internal constructor(@PublishedApi override val
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [ignored]
+         * - ❗请现在迁移到 [ignored]
         * @return [Result] 可继续向下监听
         */
        @Deprecated(message = "请使用新的命名方法", ReplaceWith("ignored()"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/MethodFinder.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/core/finder/members/MethodFinder.kt
@@ -671,7 +671,7 @@ class MethodFinder @PublishedApi internal constructor(@PublishedApi override val
         *
         * - ❗此方法已弃用 - 在之后的版本中将直接被删除
         *
-         * - ❗请现在转移到 [ignored]
+         * - ❗请现在迁移到 [ignored]
         * @return [Result] 可继续向下监听
         */
        @Deprecated(message = "请使用新的命名方法", ReplaceWith("ignored()"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/factory/ReflectionFactory.kt
@@ -226,7 +226,7 @@ fun Class<*>.toJavaPrimitiveType() = when (this) {
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [toClass]
+ * - ❗请现在迁移到 [toClass]
 * @return [Class]
 * @throws NoClassDefFoundError 如果找不到 [Class] 或设置了错误的 [ClassLoader]
 */
@@ -390,7 +390,7 @@ inline fun <reified T : Any> T.current(ignored: Boolean = false, initiate: Curre
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [buildOf]
+ * - ❗请现在迁移到 [buildOf]
 * @return [Any] or null
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("buildOf(*param, initiate)"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/factory/YukiHookFactory.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/factory/YukiHookFactory.kt
@@ -79,7 +79,7 @@ fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker) = YukiHookAPI.enca
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [Context.prefs] 方法
+ * - ❗请现在迁移到 [Context.prefs] 方法
 * @return [YukiHookPrefsBridge]
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("prefs()"))
@@ -90,7 +90,7 @@ val Context.modulePrefs get() = prefs()
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [Context.prefs] 方法
+ * - ❗请现在迁移到 [Context.prefs] 方法
 * @return [YukiHookPrefsBridge]
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("prefs(name)"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/log/LoggerFactory.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/log/LoggerFactory.kt
@@ -57,7 +57,7 @@ enum class LoggerType {
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [XPOSED_ENVIRONMENT]
+     * - ❗请现在迁移到 [XPOSED_ENVIRONMENT]
     */
    @Deprecated(message = "请使用新的命名方法", ReplaceWith("XPOSED_ENVIRONMENT"))
    XPOSEDBRIDGE,
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/param/PackageParam.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/param/PackageParam.kt
@@ -466,7 +466,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper:
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [toClass]
+     * - ❗请现在迁移到 [toClass]
     * @return [Class]
     * @throws NoClassDefFoundError 如果找不到 [Class]
     */
@@ -479,7 +479,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper:
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [toClass]
+     * - ❗请现在迁移到 [toClass]
     * @return [Class]
     * @throws IllegalStateException 如果任何 [Class] 都没有匹配到
     */
@@ -492,7 +492,7 @@ open class PackageParam internal constructor(@PublishedApi internal var wrapper:
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [hasClass]
+     * - ❗请现在迁移到 [hasClass]
     * @return [Boolean] 是否存在
     */
    @Deprecated(message = "请使用新的命名方法", ReplaceWith("hasClass()"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/type/java/VariableTypeFactory.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/type/java/VariableTypeFactory.kt
@@ -73,7 +73,7 @@ fun ArrayClass(type: Class<*>) = JavaArray.newInstance(type, 0).javaClass as Cla
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [AnyClass]
+ * - ❗请现在迁移到 [AnyClass]
 * @return [Class]<[Any]>
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("AnyClass"))
@@ -244,7 +244,7 @@ val UnitClass get() = classOf<Void>()
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [StringClass]
+ * - ❗请现在迁移到 [StringClass]
 * @return [Class]<[String]>
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("StringClass"))
@@ -255,7 +255,7 @@ val StringType get() = StringClass
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [CharSequenceClass]
+ * - ❗请现在迁移到 [CharSequenceClass]
 * @return [Class]<[CharSequence]>
 */
@Deprecated(message = "请使用新的命名方法", ReplaceWith("CharSequenceClass"))
@@ -328,7 +328,7 @@ val ShortArrayType get() = ArrayClass(ShortType)
 *
 * - ❗此方法已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [ShortArrayType]
+ * - ❗请现在迁移到 [ShortArrayType]
 * @return [Class]<[JavaArray]>
 */
@Deprecated(message = "请使用修复后的命名方法", ReplaceWith("ShortArrayType"))
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/xposed/prefs/YukiHookPrefsBridge.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/xposed/prefs/YukiHookPrefsBridge.kt
@@ -177,7 +177,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [isPreferencesAvailable]
+     * - ❗请现在迁移到 [isPreferencesAvailable]
     * @return [Boolean]
     */
    @Deprecated(message = "请使用新方式来实现此功能", ReplaceWith("isPreferencesAvailable"))
@@ -188,7 +188,7 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [isPreferencesAvailable]
+     * - ❗请现在迁移到 [isPreferencesAvailable]
     * @return [Boolean]
     */
    @Deprecated(message = "请使用新方式来实现此功能", ReplaceWith("isPreferencesAvailable"))
@@ -397,10 +397,10 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { remove(key) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { remove(key) }"))
    fun remove(key: String) = edit { remove(key) }

    /**
@@ -408,10 +408,10 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param prefs 键值实例
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { remove(prefs) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { remove(prefs) }"))
    inline fun <reified T> remove(prefs: PrefsData<T>) = edit { remove(prefs) }

    /**
@@ -419,9 +419,9 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { clear() }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { clear() }"))
    fun clear() = edit { clear() }

    /**
@@ -429,11 +429,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putString(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putString(key, value) }"))
    fun putString(key: String, value: String) = edit { putString(key, value) }

    /**
@@ -441,11 +441,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putStringSet(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putStringSet(key, value) }"))
    fun putStringSet(key: String, value: Set<String>) = edit { putStringSet(key, value) }

    /**
@@ -453,11 +453,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putBoolean(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putBoolean(key, value) }"))
    fun putBoolean(key: String, value: Boolean) = edit { putBoolean(key, value) }

    /**
@@ -465,11 +465,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putInt(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putInt(key, value) }"))
    fun putInt(key: String, value: Int) = edit { putInt(key, value) }

    /**
@@ -477,11 +477,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putFloat(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putFloat(key, value) }"))
    fun putFloat(key: String, value: Float) = edit { putFloat(key, value) }

    /**
@@ -489,11 +489,11 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     * @param key 键值名称
     * @param value 键值数据
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { putLong(key, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { putLong(key, value) }"))
    fun putLong(key: String, value: Long) = edit { putLong(key, value) }

    /**
@@ -501,9 +501,9 @@ class YukiHookPrefsBridge private constructor(private var context: Context? = nu
     *
     * - ❗此方法已弃用 - 在之后的版本中将直接被删除
     *
-     * - ❗请现在转移到 [edit] 方法
+     * - ❗请现在迁移到 [edit] 方法
     */
-    @Deprecated(message = "此方法因为性能问题已被作废，请转移到新用法", ReplaceWith("edit { put(prefs, value) }"))
+    @Deprecated(message = "此方法因为性能问题已被作废，请迁移到新用法", ReplaceWith("edit { put(prefs, value) }"))
    inline fun <reified T> put(prefs: PrefsData<T>, value: T) = edit { put(prefs, value) }

    /**
--- a/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt
+++ b/yukihookapi-core/src/main/java/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt
@@ -37,7 +37,7 @@ import com.highcapable.yukihookapi.hook.log.yLoggerW
 *
 * - ❗此接口已弃用 - 在之后的版本中将直接被删除
 *
- * - ❗请现在转移到 [IYukiHookXposedInit] 否则此接口的声明将在自动处理程序中被拦截
+ * - ❗请现在迁移到 [IYukiHookXposedInit] 否则此接口的声明将在自动处理程序中被拦截
 */
@Deprecated(message = "此接口的命名和功能已被弃用", ReplaceWith("IYukiHookXposedInit"), level = DeprecationLevel.ERROR)
 interface YukiHookXposedInitProxy {
@@ -45,16 +45,16 @@ interface YukiHookXposedInitProxy {
    /**
     * - ❗此方法已过时
     *
-     * - ❗请将接口转移到 [IYukiHookXposedInit]
+     * - ❗请将接口迁移到 [IYukiHookXposedInit]
     */
-    @Deprecated(message = "请将接口转移到 IYukiHookXposedInit", level = DeprecationLevel.ERROR)
+    @Deprecated(message = "请将接口迁移到 IYukiHookXposedInit", level = DeprecationLevel.ERROR)
    fun onInit() = yLoggerW(msg = "YukiHookXposedInitProxy was deprecated")

    /**
     * - ❗此方法已过时
     *
-     * - ❗请将接口转移到 [IYukiHookXposedInit]
+     * - ❗请将接口迁移到 [IYukiHookXposedInit]
     */
-    @Deprecated(message = "请将接口转移到 IYukiHookXposedInit", level = DeprecationLevel.ERROR)
+    @Deprecated(message = "请将接口迁移到 IYukiHookXposedInit", level = DeprecationLevel.ERROR)
    fun onHook() = yLoggerW(msg = "YukiHookXposedInitProxy was deprecated")
 }