Update README: getters/setters plugin configs 'keepWithAnnotations'.

Minuit-Z · Jan 19, 2020 · 3ef37c3 · 3ef37c3
1 parent 039805d
commit 3ef37c3
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/example/src/main/java/com/ss/android/ugc/bytex/example/CalledByNative.java b/example/src/main/java/com/ss/android/ugc/bytex/example/CalledByNative.java
@@ -0,0 +1,4 @@
+package com.ss.android.ugc.bytex.example;
+
+public @interface CalledByNative {
+}
diff --git a/getter-setter-inline-plugin/README-zh.md b/getter-setter-inline-plugin/README-zh.md
@@ -40,9 +40,14 @@ getter_setter_inline {
     enable true
     enableInDebug false
     logLevel "DEBUG"
+    // 跳过Proguard的Keep规则，强制内联这些包名下的类的getter/setter方法
     shouldInline = [
         "com/ss/android/ugc/bytex/example/getter_setter/"
     ]
+    // 除了可以通过Proguard的keep规则来避免一些方法被内联外，还可以自定义一些注解，标注到这些方法上
+    keepWithAnnotations = [
+        "com/ss/android/ugc/bytex/example/CalledByNative"
+    ]
 }
 ```
 

diff --git a/getter-setter-inline-plugin/README.md b/getter-setter-inline-plugin/README.md
@@ -40,9 +40,14 @@ getter_setter_inline {
     enable true
     enableInDebug false
     logLevel "DEBUG"
+    // Ignore the keep rules configuration of Proguard, force to inline the getters/setters of the classes in those packages.
     shouldInline = [
         "com/ss/android/ugc/bytex/example/getter_setter/"
     ]
+    // besides the keep rules of Proguard, we can customize some annotations to keep some getters/setters methods from being inlined.
+    keepWithAnnotations = [
+        "com/ss/android/ugc/bytex/example/CalledByNative"
+    ]
 }
 ```