Added English translation in code note in demo

demo-module/src/main/java/com/highcapable/yukihookapi/demo_module/hook/HookEntry.kt

@@ -53,25 +53,45 @@ import com.highcapable.yukihookapi.hook.xposed.proxy.IYukiHookXposedInit
 class HookEntry : IYukiHookXposedInit {
 
     override fun onInit() {
+        // Configure YuKiHookAPI
+        // Can be shortened to configs {}
         // 配置 YuKiHookAPI
         // 可简写为 configs {}
         YukiHookAPI.configs {
+            // Configure YukiHookLogger
             // 配置 YukiHookLogger
             debugLog {
+                // TAG for global debugging
+                // Filter this TAG in the Logcat console to find detailed logs
                 // 全局调试用的 TAG
                 // 在 Logcat 控制台过滤此 TAG 可找到详细日志
                 tag = "YukiHookAPI-Demo"
+                // Whether to enable the output function of the debug log, enabled by default
+                // When closed, the API will stop output all logs, it is recommended not to disable this option arbitrarily
+                // Although it is incorrect to say that a lot of logs are written to the user's device, but NO LOG NO DEBUGGABLE
+                // Whether the log will affect the fluency of the device has always been a false proposition
+                // But if not has this option may cause some criticism, it is recommended not to close it
                 // 是否启用调试日志的输出功能 - 默认启用
                 // 一旦关闭后除手动日志外 API 将停止全部日志的输出 - 建议不要随意关掉这个选项
                 // 虽然说对用户的设备写入大量日志是不正确的 - 但是没有日志你将无法调试
                 // 关于日志是否会影响设备的流畅度一直是一个伪命题
                 // 但是不设置这个选项可能会引起一些非议 - 建议不要关闭就是了
                 isEnable = true
+                // Whether to enable the logging function of debug log, not enabled by default
+                // When enabled, all available logs and exception stacks will be recorded in memory
+                // Please note, excessive logging may slow down the Host App or cause frequent GCs
+                // After enabling, you can call [YukiHookLogger.saveToFile] to save the log to file in real-time
+                // Or use [YukiHookLogger.contents] to get the real-time log file contents
                 // 是否启用调试日志的记录功能 - 默认不启用
                 // 开启后将会在内存中记录全部可用的日志和异常堆栈
                 // 请注意 - 过量的日志可能会导致宿主运行缓慢或造成频繁 GC
                 // 开启后你可以调用 [YukiHookLogger.saveToFile] 实时保存日志到文件或使用 [YukiHookLogger.contents] 获取实时日志文件
                 isRecord = false
+                // Customize the elements displayed by the debug log externally
+                // Only valid for logging and [XposedBridge.log]
+                // The arrangement of log elements will be displayed in the order you set in [item]
+                // You can also leave [item] blank to not show all elements except the log content
+                // Available elements are: [TAG], [PRIORITY], [PACKAGE_NAME], [USER_ID]
                 // 自定义调试日志对外显示的元素
                 // 只对日志记录和 [XposedBridge.log] 生效
                 // 日志元素的排列将按照你在 [item] 中设置的顺序进行显示
@@ -79,33 +99,59 @@ class HookEntry : IYukiHookXposedInit {
                 // 可用的元素有：[TAG]、[PRIORITY]、[PACKAGE_NAME]、[USER_ID]
                 elements(TAG, PRIORITY, PACKAGE_NAME, USER_ID)
             }
+            // Whether to enable debug mode
+            // Please note, for a release build, be sure to turn off debugging to prevent a lot of log stuffing on the user's device
             // 是否开启调试模式
             // 请注意 - 若作为发布版本请务必关闭调试功能防止对用户设备造成大量日志填充
             isDebug = true
+            // Whether to enable the key-value cache function of [YukiHookModulePrefs]
+            // If there is no frequent interaction data with the Module App, it is recommended to enable it before the Host App restarts
+            // If you need real-time interactive data, it is recommended to close or configure dynamically from [YukiHookModulePrefs]
             // 是否启用 [YukiHookModulePrefs] 的键值缓存功能
             // 若无和模块频繁交互数据在宿主重新启动之前建议开启
             // 若需要实时交互数据建议关闭或从 [YukiHookModulePrefs] 中进行动态配置
             isEnableModulePrefsCache = true
+            // Whether to enable the current Xposed Module's own [Resources] cache function
+            // Under normal circumstances, the resources of the Module App will not change
+            // But in the case of locale changes, screen size changes. Etc. you need to refresh the cache
+            // If none of the above requirements, it is recommended to enable it before the Host App restarts
+            // You can manually call [PackageParam.refreshModuleAppResources] to refresh the cache
             // 是否启用当前 Xposed 模块自身 [Resources] 缓存功能
             // 一般情况下模块的 Resources 是不会改变的 - 但是在语言区域更改、分辨率更改等情况下 - 就需要刷新缓存
             // 若无上述需求 - 在宿主重新启动之前建议开启
             // 你可以手动调用 [PackageParam.refreshModuleAppResources] 来刷新缓存
             isEnableModuleAppResourcesCache = true
+            // Whether to enable status functions such as Hook Xposed Module activation
+            // Enable state detection for natively supported Xposed Modules, this feature is enabled by default
+            // After closing you will no longer be able to use the functions in [YukiHookAPI.Status] in the Module environment
+            // When the feature is enabled, it will be automatically hooked [YukiHookModuleStatus] when the Host App starts up
             // 是否启用 Hook Xposed 模块激活等状态功能
             // 为原生支持 Xposed 模块激活状态检测 - 此功能默认启用
             // 关闭后你将不能再在模块环境中使用 [YukiHookAPI.Status] 中的功能
             // 功能启用后 - 将会在宿主启动时自动 Hook [YukiHookModuleStatus]
             isEnableHookModuleStatus = true
+            // Whether to enable Hook [SharedPreferences]
+            // Enable will force [SharedPreferences] file permissions to be adjusted to [Context.MODE_WORLD_READABLE] (0664) at Module App startup
+            // This is an optional experimental feature, this feature is not enabled by default
+            // Only used to fix some systems that may still have file permission errors after enabling New XSharedPreferences
+            // If you can use [YukiHookModulePrefs] normally, it is not recommended to enable this feature
             // 是否启用 Hook [SharedPreferences]
             // 启用后将在模块启动时强制将 [SharedPreferences] 文件权限调整为 [Context.MODE_WORLD_READABLE] (0664)
             // 这是一个可选的实验性功能 - 此功能默认不启用
             // 仅用于修复某些系统可能会出现在启用了 New XSharedPreferences 后依然出现文件权限错误问题 - 若你能正常使用 [YukiHookModulePrefs] 就不建议启用此功能
             isEnableHookSharedPreferences = false
+            // Whether to enable the [YukiHookDataChannel] function of the current Xposed Module interacting with the Host App
+            // Please make sure the Xposed Module's [Application] extends [ModuleApplication] to be valid
+            // This feature is enabled by default, when disabled it will not load [YukiHookDataChannel] when the feature is initialized
+            // When the feature is enabled, it will automatically register the Hook [Application] lifecycle method when the Host App starts
             // 是否启用当前 Xposed 模块与宿主交互的 [YukiHookDataChannel] 功能
             // 请确保 Xposed 模块的 [Application] 继承于 [ModuleApplication] 才能有效
             // 此功能默认启用 - 关闭后将不会在功能初始化的时候装载 [YukiHookDataChannel]
             // 功能启用后 - 将会在宿主启动时自动 Hook [Application] 的生命周期方法进行注册
             isEnableDataChannel = true
+            // Whether to enable the [Member] cache function
+            // To prevent system GC problems caused by high multiplexing of [Member], this feature is enabled by default
+            // Unless the cached [Member] is obfuscated, it is recommended to enable
             // 是否启用 [Member] 缓存功能
             // 为防止 [Member] 复用过高造成的系统 GC 问题 - 此功能默认启用
             // 除非缓存的 [Member] 发生了混淆的问题 - 否则建议启用
@@ -114,11 +160,15 @@ class HookEntry : IYukiHookXposedInit {
     }
 
     override fun onHook() {
+        // Start your hook
+        // Can be shortened to encase {}
         // 开始你的 Hook
         // 可简写为 encase {}
         YukiHookAPI.encase {
+            // Load App Zygote event
             // 装载 APP Zygote 事件
             loadZygote {
+                // Find Class to hook
                 // 得到需要 Hook 的 Class
                 ActivityClass.hook {
                     injectMember {
@@ -127,34 +177,46 @@ class HookEntry : IYukiHookXposedInit {
                             param(BundleClass)
                         }
                         afterHook {
+                            // Add text after the [Activity] title
                             // 在 [Activity] 标题后方加入文字
                             instance<Activity>().apply { title = "$title [Active]" }
                         }
                     }
                 }
+                // Find Resources to hook
+                // Requires Hook Framework to support Resources Hook to succeed
+                // Resources Hook in Zygote only needs Hook Framework support, no need to enable this feature
                 // 得到需要 Hook 的 Resources
                 // 需要 Hook Framework 支持 Resources Hook(资源钩子) 才能成功
                 // 在 Zygote 中的 Resources Hook 只需要 Hook Framework 支持 - 无需启用此功能
                 resources().hook {
+                    // Inject the Resources to be hooked
                     // 注入要 Hook 的 Resources
                     injectResource {
+                        // Set the conditions
                         // 设置条件
                         conditions {
                             name = "sym_def_app_icon"
                             mipmap()
                         }
+                        // Replace with the Resources of the current Module App
+                        // Module App's Resources can be obfuscated with R8, results are not affected
                         // 替换为当前模块的 Resources
                         // 模块的 Resources 可以使用 R8 混淆 - 结果不受影响
                         replaceToModuleResource(R.mipmap.ic_icon)
                     }
                 }
             }
+            // Load the app to be hooked
             // 装载需要 Hook 的 APP
             loadApp(name = "com.highcapable.yukihookapi.demo_app") {
+                // Register Activity Proxy
                 // 注册模块 Activity 代理
                 onAppLifecycle { onCreate { registerModuleAppActivities() } }
+                // Find Class to hook
                 // 得到需要 Hook 的 Class
                 findClass(name = "$packageName.ui.MainActivity").hook {
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
@@ -162,15 +224,18 @@ class HookEntry : IYukiHookXposedInit {
                             emptyParam()
                             returnType = StringType
                         }
+                        // Replaced hook
                         // 执行替换 Hook
                         replaceTo(any = "Hello YukiHookAPI!")
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
                             name = "onCreate"
                             param(BundleClass)
                         }
+                        // Before hook the method
                         // 在方法执行之前拦截
                         beforeHook {
                             field {
@@ -178,6 +243,7 @@ class HookEntry : IYukiHookXposedInit {
                                 type = StringType
                             }.get(instance).set("I am hook result")
                         }
+                        // After hook the method
                         // 在执行方法之后拦截
                         afterHook {
                             if (prefs.getBoolean("show_dialog_when_demo_app_opend"))
@@ -193,6 +259,7 @@ class HookEntry : IYukiHookXposedInit {
                                     .show().compatStyle()
                         }
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
@@ -200,14 +267,18 @@ class HookEntry : IYukiHookXposedInit {
                             param(StringType)
                             returnType = StringType
                         }
+                        // Before hook the method
                         // 在方法执行之前拦截
                         beforeHook {
+                            // Set the 0th param (recomment)
                             // 设置 0 号 param (推荐)
                             args().first().set("I am hook method param")
+                            // The following method is also ok
                             // 下面这种方式也是可以的
                             // args[0] = "I am hook method param"
                         }
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
@@ -215,12 +286,15 @@ class HookEntry : IYukiHookXposedInit {
                             param(StringArrayClass)
                             returnType = StringArrayClass
                         }
+                        // Before hook the method
                         // 在方法执行之前拦截
                         beforeHook {
+                            // Set the 0th param
                             // 设置 0 号 param
                             args().first().array<String>()[0] = "peach"
                         }
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
@@ -228,6 +302,7 @@ class HookEntry : IYukiHookXposedInit {
                             emptyParam()
                             returnType = UnitType
                         }
+                        // Intercept the entire method
                         // 拦截整个方法
                         replaceUnit {
                             instance<Activity>().applyModuleTheme(R.style.Theme_Default).also { context ->
@@ -249,6 +324,7 @@ class HookEntry : IYukiHookXposedInit {
                             }
                         }
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
@@ -256,81 +332,111 @@ class HookEntry : IYukiHookXposedInit {
                             emptyParam()
                             returnType = StringType
                         }
+                        // Replaced hook
                         // 执行替换 Hook
                         replaceTo(prefs.get(DataConst.TEST_KV_DATA))
                     }
                 }
+                // Find Class to hook
                 // 得到需要 Hook 的 Class
                 findClass(name = "$packageName.test.Main").hook {
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         constructor { param(StringType) }
+                        // Before hook the method
                         // 在方法执行之前拦截
                         beforeHook {
+                            // Set the 0th param
                             // 设置 0 号 param
                             args().first().set("I am hook constructor param")
                         }
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method {
                             name = "getSuperString"
                             emptyParam()
+                            // This method is not in the current Class
+                            // Just set this find condition to automatically go to the super class of the current Class to find
+                            // Since the method shown will only exist in the super class
+                            // So you can set only the super class to find isOnlySuperClass = true to save time
+                            // If you want to keep trying to find the current Class, please remove isOnlySuperClass = true
                             // 这个方法不在当前的 Class
                             // 只需要设置此查找条件即可自动前往当前 Class 的父类查找
                             // 由于演示的方法只会在父类存在 - 所以可以设置仅查找父类 isOnlySuperClass = true 节省时间
                             // 如果想继续尝试查找当前 Class - 请删除 isOnlySuperClass = true
                             superClass(isOnlySuperClass = true)
                         }
+                        // Replaced hook
                         // 执行替换 Hook
                         replaceTo(any = "I am hook super class method")
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method { name = "getTestResultFirst" }.all()
+                        // Replaced hook
                         // 执行替换 Hook
                         replaceTo(any = "I am hook all methods first")
                     }
+                    // Inject the method to be hooked
                     // 注入要 Hook 的方法
                     injectMember {
                         method { name = "getTestResultLast" }.all()
+                        // Replaced hook
                         // 执行替换 Hook
                         replaceTo(any = "I am hook all methods last")
                     }
                 }
+                // Find Resources to hook
+                // Requires Hook Framework to support Resources Hook to succeed
+                // Resources Hook in Zygote only needs Hook Framework support, no need to enable this feature
                 // 得到需要 Hook 的 Resources
                 // 需要 Hook Framework 支持 Resources Hook(资源钩子) 且启用此功能才能成功
                 resources().hook {
+                    // Inject the Resources to be hooked
                     // 注入要 Hook 的 Resources
                     injectResource {
+                        // Set the conditions
                         // 设置条件
                         conditions {
                             name = "activity_main"
                             layout()
                         }
+                        // Hook layout inflater
                         // Hook 布局装载器
                         injectAsLayout {
+                            // Replace the button text with the specified Id in this layout
                             // 替换布局中指定 Id 的按钮文本
                             findViewByIdentifier<Button>(name = "app_demo_button")?.text = "Touch Me!"
                         }
                     }
+                    // Inject the Resources to be hooked
                     // 注入要 Hook 的 Resources
                     injectResource {
+                        // Set the conditions
                         // 设置条件
                         conditions {
                             name = "test_string"
                             string()
                         }
+                        // Replace with the specified Resources
                         // 替换为指定的 Resources
                         replaceTo(any = "I am hook to make your Happy")
                     }
+                    // Inject the Resources to be hooked
                     // 注入要 Hook 的 Resources
                     injectResource {
+                        // Set the conditions
                         // 设置条件
                         conditions {
                             name = "ic_face_unhappy"
                             mipmap()
                         }
+                        // Replace with the Resources of the current Module App
+                        // Module App's Resources can be obfuscated with R8, results are not affected
                         // 替换为当前模块的 Resources
                         // 模块的 Resources 可以使用 R8 混淆 - 结果不受影响
                         replaceToModuleResource(R.mipmap.ic_face_happy)
@@ -340,22 +446,32 @@ class HookEntry : IYukiHookXposedInit {
         }
     }
 
+    // Optional listener function, you can not override this method if you don't need it
+    // This method is implemented in Demo only to introduce its function
     // 可选的监听功能 - 如不需要你可以不重写这个方法
     // Demo 中实现这个方法仅为了介绍它的功能
     override fun onXposedEvent() {
+        // (Optional) Listen to the loading event of the native Xposed API
+        // If your Hook event has native Xposed functionality that needs to be compatible, it can be implemented here
+        // Don't handle any YukiHookAPI events here, do it in onHook
         // (可选) 监听原生 Xposed API 的装载事件
         // 若你的 Hook 事件中存在需要兼容的原生 Xposed 功能 - 可在这里实现
         // 不要在这里处理任何 YukiHookAPI 的事件 - 请在 onHook 中完成
         YukiXposedEvent.events {
             onInitZygote {
+                // Implement listening for the initZygote event
                 // 实现监听 initZygote 事件
             }
             onHandleLoadPackage {
+                // Implement listener handleLoadPackage event
+                // Call native Xposed API methods
                 // 实现监听 handleLoadPackage 事件
                 // 可调用原生 Xposed API 方法
                 // XposedHelpers.findAndHookMethod("className", it.classLoader, "methodName", object : XC_MethodHook())
             }
             onHandleInitPackageResources {
+                // Implement the listener handleInitPackageResources event
+                // Call native Xposed API methods
                 // 实现监听 handleInitPackageResources 事件
                 // 可调用原生 Xposed API 方法
                 // it.res.setReplacement(0x7f060001, "replaceMent")

demo-module/src/main/java/com/highcapable/yukihookapi/demo_module/hook/factory/ComponentCompatFactory.kt

@@ -34,6 +34,10 @@ import androidx.appcompat.app.AlertDialog
 import com.highcapable.yukihookapi.hook.factory.current
 
 /**
+ * Fixed [AlertDialog] dialog button issue after injecting Module App's Resources in some Host Apps
+ *
+ * Reset button text color and background by reflection [Drawable]
+ *
  * 修复 [AlertDialog] 对话框按钮在一些宿主中注入模块资源后会发生问题
  *
  * 通过反射重新设置按钮的文字颜色和背景 [Drawable]

demo-module/src/main/java/com/highcapable/yukihookapi/demo_module/hook/java/HookEntry.java

@@ -35,10 +35,16 @@ import com.highcapable.yukihookapi.hook.log.YukiHookLogger;
 import com.highcapable.yukihookapi.hook.xposed.bridge.event.YukiXposedEvent;
 import com.highcapable.yukihookapi.hook.xposed.proxy.IYukiHookXposedInit;
 
+// ========
+// This only demonstrates how to use it in the Java case (Java 1.8+ only)
+// The code here is for demonstration only， does not mean that it will work in the future， Demo will only sync the latest Kotlin usage
+// It is recommended to use Kotlin to complete the writing of the Hook part
+// Please remove the code note "//" below to use this demo, but make sure to comment out the HookEntry annotation on the Kotlin side
 // 这里仅演示了 Java 情况下的使用方式 (仅限 Java 1.8+)
 // 这里的代码仅供演示 - 并不代表今后都可以正常运行 - Demo 只会同步最新的 Kotlin 使用方法
 // 建议还是使用 Kotlin 来完成 Hook 部分的编写
-// 请删除下方的注释以使用此 Demo - 但要确保注释掉 Kotlin 一边的 HookEntry 的注解
+// 请删除下方的注释 "//" 以使用此 Demo - 但要确保注释掉 Kotlin 一边的 HookEntry 的注解
+// ========
 // @InjectYukiHookWithXposed
 public class HookEntry implements IYukiHookXposedInit {
 
@@ -64,6 +70,8 @@ public class HookEntry implements IYukiHookXposedInit {
 
     @Override
     public void onHook() {
+        // Here is the Java writing method that is more similar to the Kotlin writing method, just for reference
+        // Calling Kotlin's lambda in Java also needs to return null in the Unit case
         // 这里介绍了比较近似于 Kotlin 写法的 Java 写法 - 仅供参考
         // 在 Java 中调用 Kotlin 的 lambda 在 Unit 情况下也需要 return null
         YukiHookAPI.INSTANCE.encase(e -> {
@@ -86,6 +94,7 @@ public class HookEntry implements IYukiHookXposedInit {
                 });
                 return null;
             });
+            // The rest of the code has been omitted, you can continue to refer to the above method to complete
             // 余下部分代码已略 - 可继续参考上述方式完成
             // ...
             return null;
@@ -94,18 +103,23 @@ public class HookEntry implements IYukiHookXposedInit {
 
     @Override
     public void onXposedEvent() {
+        // Since Java does not support some methods that do not override Kotlin Interface
+        // So this method is not needed here, you can leave the content blank
         // 由于 Java 不支持不重写 Kotlin Interface 的部分方法
         // 所以不需要此方法这里可以不填写内容
         YukiXposedEvent event = YukiXposedEvent.INSTANCE;
         event.onInitZygote(startupParam -> {
+            // Write the startupParam method here
             // 这里编写 startupParam 方法
             return null;
         });
         event.onHandleLoadPackage(loadPackageParam -> {
+            // Write the loadPackageParam method here
             // 这里编写 loadPackageParam 方法
             return null;
         });
         event.onHandleInitPackageResources(resourcesParam -> {
+            // Write the resourcesParam method here
             // 这里编写 resourcesParam 方法
             return null;
         });

demo-module/src/main/java/com/highcapable/yukihookapi/demo_module/ui/MainActivity.kt

@@ -93,16 +93,20 @@ class MainActivity : ModuleAppCompatActivity() {
     }
 
     /**
+     * Running only in (Xposed) Host environment
+     *
      * 仅在 (Xposed) 宿主环境执行
-     * @param callback 在模块环境执行
+     * @param callback Running in the (Xposed) Host environment / 在宿主环境执行
      */
     private inline fun hostEnvironment(callback: () -> Unit) {
         if (YukiHookAPI.Status.isXposedEnvironment) callback()
     }
 
     /**
+     * Running only in Module environment
+     *
      * 仅在模块环境执行
-     * @param callback 在模块环境执行
+     * @param callback Running in the Module environment / 在模块环境执行
      */
     private inline fun moduleEnvironment(callback: () -> Unit) {
         if (YukiHookAPI.Status.isXposedEnvironment.not()) callback()