Modify canonical code comment Host and Module environment naming

docs/api/public/YukiHookAPI.md

@@ -128,7 +128,7 @@ val isModuleActive: Boolean
 
 !> 在模块环境中需要启用 `Configs.isEnableHookModuleStatus`。
 
-!> 在 Xposed 环境中仅返回非 `isTaiChiModuleActive` 的激活状态。
+!> 在 (Xposed) 宿主环境中仅返回非 `isTaiChiModuleActive` 的激活状态。
 
 #### isXposedModuleActive [field]
 
@@ -146,7 +146,7 @@ val isXposedModuleActive: Boolean
 
 !> 在模块环境中需要启用 `Configs.isEnableHookModuleStatus`。
 
-!> 在 Xposed 环境中始终返回 true。
+!> 在 (Xposed) 宿主环境中始终返回 true。
 
 #### isTaiChiModuleActive [field]
 
@@ -164,7 +164,7 @@ val isTaiChiModuleActive: Boolean
 
 !> 在模块环境中你需要将 `Application` 继承于 `ModuleApplication`。
 
-!> 在 Xposed 环境中始终返回 false。
+!> 在 (Xposed) 宿主环境中始终返回 false。
 
 #### isSupportResourcesHook [field]
 
@@ -182,7 +182,7 @@ val isSupportResourcesHook: Boolean
 
 !> 在模块环境中需要启用 `Configs.isEnableHookModuleStatus`。
 
-!> 在 Xposed 环境中可能会延迟等待事件回调后才会返回 true。
+!> 在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。
 
 !> 请注意你需要确保 `InjectYukiHookWithXposed.isUsingResourcesHook` 已启用，否则始终返回 false。
 

docs/api/public/YukiHookModulePrefs.md

@@ -56,7 +56,7 @@ val isXSharePrefsReadable: Boolean
 
 > 获取 `XSharedPreferences` 是否可读。
 
-!> 只能在 `isXposedEnvironment` 中使用，模块环境中始终返回 false。
+!> 只能在 (Xposed) 宿主环境中使用，模块环境中始终返回 false。
 
 ### isRunInNewXShareMode [field]
 
@@ -74,7 +74,7 @@ val isRunInNewXShareMode: Boolean
 
 前提条件为当前 Xposed 模块已被激活。
 
-!> 只能在模块环境中使用，`isXposedEnvironment` 环境中始终返回 false
+!> 只能在模块环境中使用，(Xposed) 宿主环境中始终返回 false
 
 ### name [method]
 
@@ -100,7 +100,7 @@ fun name(name: String): YukiHookModulePrefs
 modulePrefs("custom_name").getString("custom_key")
 ```
 
-在 Xposed 模块环境 `PackageParam` 中的使用方法。
+在 (Xposed) 宿主环境 `PackageParam` 中的使用方法。
 
 > 示例如下
 
@@ -242,7 +242,7 @@ fun remove(key: String)
 
 > 移除全部包含 `key` 的存储数据。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### remove [method]
 
@@ -258,7 +258,7 @@ inline fun <reified T> remove(prefs: PrefsData<T>)
 
 > 移除 `PrefsData.key` 的存储数据。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### clear [method]
 
@@ -274,7 +274,7 @@ fun clear()
 
 > 移除全部存储数据。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putString [method]
 
@@ -290,7 +290,7 @@ fun putString(key: String, value: String)
 
 > 存储 `String` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putStringSet [method]
 
@@ -306,7 +306,7 @@ fun putStringSet(key: String, value: Set<String>)
 
 > 存储 `Set<String>` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putBoolean [method]
 
@@ -322,7 +322,7 @@ fun putBoolean(key: String, value: Boolean)
 
 > 存储 `Boolean` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putInt [method]
 
@@ -338,7 +338,7 @@ fun putInt(key: String, value: Int)
 
 > 存储 `Int` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putLong [method]
 
@@ -354,7 +354,7 @@ fun putLong(key: String, value: Long)
 
 > 存储 `Long` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### putFloat [method]
 
@@ -370,7 +370,7 @@ fun putFloat(key: String, value: Float)
 
 > 存储 `Float` 键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### get [method]
 
@@ -400,7 +400,7 @@ inline fun <reified T> put(prefs: PrefsData<T>, value: T)
 
 > 智能存储指定类型的键值。
 
-!> 在 `XSharedPreferences` 环境下只读，无法使用。
+!> 在 (Xposed) 宿主环境下只读，无法使用。
 
 ### clearCache [method]
 
@@ -420,4 +420,6 @@ fun clearCache()
 
 调用此方法将清除当前存储的全部键值缓存。
 
-下次将从 `XSharedPreferences` 重新读取。
+下次将从 `XSharedPreferences` 重新读取。
+
+在 (Xposed) 宿主环境中使用。

yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt

@@ -112,7 +112,7 @@ object YukiHookAPI {
          *
          * - ❗在模块环境中需要启用 [Configs.isEnableHookModuleStatus]
          *
-         * - ❗在 Xposed 环境中仅返回非 [isTaiChiModuleActive] 的激活状态
+         * - ❗在 (Xposed) 宿主环境中仅返回非 [isTaiChiModuleActive] 的激活状态
          * @return [Boolean] 是否激活
          */
         val isModuleActive get() = YukiHookBridge.hasXposedBridge || YukiHookModuleStatus.isActive() || isTaiChiModuleActive
@@ -122,7 +122,7 @@ object YukiHookAPI {
          *
          * - ❗在模块环境中需要启用 [Configs.isEnableHookModuleStatus]
          *
-         * - ❗在 Xposed 环境中始终返回 true
+         * - ❗在 (Xposed) 宿主环境中始终返回 true
          * @return [Boolean] 是否激活
          */
         val isXposedModuleActive get() = YukiHookBridge.hasXposedBridge || YukiHookModuleStatus.isActive()
@@ -132,7 +132,7 @@ object YukiHookAPI {
          *
          * - ❗在模块环境中你需要将 [Application] 继承于 [ModuleApplication]
          *
-         * - ❗在 Xposed 环境中始终返回 false
+         * - ❗在 (Xposed) 宿主环境中始终返回 false
          * @return [Boolean] 是否激活
          */
         val isTaiChiModuleActive
@@ -143,7 +143,7 @@ object YukiHookAPI {
          *
          * - ❗在模块环境中需要启用 [Configs.isEnableHookModuleStatus]
          *
-         * - ❗在 Xposed 环境中可能会延迟等待事件回调后才会返回 true
+         * - ❗在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true
          *
          * - ❗请注意你需要确保 [InjectYukiHookWithXposed.isUsingResourcesHook] 已启用 - 否则始终返回 false
          * @return [Boolean] 是否支持

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

@@ -65,7 +65,7 @@ class YukiHookDataChannel private constructor() {
 
     internal companion object {
 
-        /** 是否为 Xposed 环境 */
+        /** 是否为 (Xposed) 宿主环境 */
         private val isXposedEnvironment = YukiHookBridge.hasXposedBridge
 
         /** 模块构建版本号获取标签 */

yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/prefs/YukiHookModulePrefs.kt

@@ -67,7 +67,7 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
 
     internal companion object {
 
-        /** 是否为 Xposed 环境 */
+        /** 是否为 (Xposed) 宿主环境 */
         private val isXposedEnvironment = YukiHookBridge.hasXposedBridge
 
         /** 当前 [YukiHookModulePrefs] 单例 */
@@ -75,7 +75,7 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
 
         /**
          * 获取 [YukiHookModulePrefs] 单例
-         * @param context 实例 - Xposed 环境为空
+         * @param context 实例 -  (Xposed) 宿主环境为空
          * @return [YukiHookModulePrefs]
          */
         internal fun instance(context: Context? = null) =
@@ -166,7 +166,7 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
     /**
      * 获取 [XSharedPreferences] 是否可读
      *
-     * - ❗只能在 [isXposedEnvironment] 中使用 - 模块环境中始终返回 false
+     * - ❗只能在 (Xposed) 宿主环境中使用 - 模块环境中始终返回 false
      * @return [Boolean] 是否可读
      */
     val isXSharePrefsReadable get() = runCatching { xPref.let { it.file.exists() && it.file.canRead() } }.getOrNull() ?: false
@@ -176,8 +176,8 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 前提条件为当前 Xposed 模块已被激活
      *
-     * - ❗只能在模块环境中使用 - [isXposedEnvironment] 环境中始终返回 false
-     * @return [Boolean] 仅限在模块中判断 - 在宿主 [XSharedPreferences] 环境中始终返回 false
+     * - ❗只能在模块环境中使用 - (Xposed) 宿主环境中始终返回 false
+     * @return [Boolean] 仅限在模块中判断 - 在 (Xposed) 宿主环境中始终返回 false
      */
     val isRunInNewXShareMode
         get() = runCatching {
@@ -377,9 +377,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
     /**
      * 移除全部包含 [key] 的存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      */
     fun remove(key: String) = moduleEnvironment {
@@ -390,9 +390,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
     /**
      * 移除 [PrefsData.key] 的存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param prefs 键值实例
      */
     inline fun <reified T> remove(prefs: PrefsData<T>) = remove(prefs.key)
@@ -400,9 +400,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
     /**
      * 移除全部存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      */
     fun clear() = moduleEnvironment {
         sPref.edit().clear().apply()
@@ -414,9 +414,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -430,9 +430,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -446,9 +446,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -462,9 +462,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -478,9 +478,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -494,9 +494,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * - 建议使用 [PrefsData] 创建模板并使用 [put] 存储数据
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值名称
      * @param value 键值数据
      */
@@ -516,9 +516,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
     /**
      * 智能存储指定类型的键值
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param prefs 键值实例
      * @param value 要存储的值 - 只能是 [String]、[Int]、[Float]、[Long]、[Boolean]
      */
@@ -548,9 +548,9 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      *
      * 封装方法以调用内联方法
      *
-     * - 在模块 [Context] 环境中使用
+     * - 在模块环境中使用
      *
-     * - ❗在 [XSharedPreferences] 环境下只读 - 无法使用
+     * - ❗在 (Xposed) 宿主环境下只读 - 无法使用
      * @param key 键值
      * @param value 要存储的值 - 只能是 [String]、[Int]、[Float]、[Long]、[Boolean]
      */
@@ -573,6 +573,8 @@ class YukiHookModulePrefs private constructor(private var context: Context? = nu
      * 调用此方法将清除当前存储的全部键值缓存
      *
      * 下次将从 [XSharedPreferences] 重新读取
+     *
+     * - 在 (Xposed) 宿主环境中使用
      */
     fun clearCache() {
         xPrefCacheKeyValueStrings.clear()