HighCapable/moshi-companion
5
0
Fork 0
mirror of https://github.com/HighCapable/moshi-companion.git synced 2025-10-18 16:49:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update guide

Browse Source
This commit is contained in:
fankesyooni
2025-10-07 08:26:25 +08:00
parent afa0ee5c2e
commit 04b44ddec9
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/guide-zh-CN.md
View File

@@ -115,7 +115,7 @@ val moshi = Moshi.Builder()
```kotlin ```kotlin
ksp { ksp {
// 自定义 AdapterRegistry 的包名，如果是 Android 项目，推荐直接使用 "android.namespace" // 自定义 AdapterRegistry 的包名，如果是 Android 项目，推荐直接使用 "android.namespace"
arg("moshi-companion.generateAdapterRegistryPackageName", "com.yourdomain.yourpackage.generated") arg("moshi-companion.generateAdapterRegistryPackageName", "com.yourdomain.yourpackage")
// 自定义 AdapterRegistry 的类名 // 自定义 AdapterRegistry 的类名
arg("moshi-companion.generateAdapterRegistryClassName", "YourCustomMoshiAdapterRegistry") arg("moshi-companion.generateAdapterRegistryClassName", "YourCustomMoshiAdapterRegistry")
} }
@@ -198,10 +198,10 @@ val adapter = moshi.adapter<List<YourDataClass>>(type)
release { release {
isMinifyEnabled = true isMinifyEnabled = true
proguardFiles( proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro", // 指定 Moshi Companion 生成的混淆规则文件
// 指定 Moshi Companion 生成的混淆规则文件 file("build/generated/ksp/release/resources/META-INF/proguard/").listFiles()?.firstOrNull()?.let {
file("build/generated/ksp/release/resources/META-INF/proguard/").listFiles()!!.first() proguardFiles(it)
) }
} }
``` ```

12
docs/guide.md
View File

@@ -115,7 +115,7 @@ If you need to customize the class name and package name of `AdapterRegistry`, y
```kotlin ```kotlin
ksp { ksp {
// Customize the package name of AdapterRegistry, if it's an Android project, it's recommended to directly use "android.namespace" // Customize the package name of AdapterRegistry, if it's an Android project, it's recommended to directly use "android.namespace"
arg("moshi-companion.generateAdapterRegistryPackageName", "com.yourdomain.yourpackage.generated") arg("moshi-companion.generateAdapterRegistryPackageName", "com.yourdomain.yourpackage")
// Customize the class name of AdapterRegistry // Customize the class name of AdapterRegistry
arg("moshi-companion.generateAdapterRegistryClassName", "YourCustomMoshiAdapterRegistry") arg("moshi-companion.generateAdapterRegistryClassName", "YourCustomMoshiAdapterRegistry")
} }
@@ -198,10 +198,10 @@ Currently in Android projects, this issue may occur in the main project module (
release { release {
isMinifyEnabled = true isMinifyEnabled = true
proguardFiles( proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro", // Specify the ProGuard rules file generated by Moshi Companion
// Specify the ProGuard rules file generated by Moshi Companion file("build/generated/ksp/release/resources/META-INF/proguard/").listFiles()?.firstOrNull()?.let {
file("build/generated/ksp/release/resources/META-INF/proguard/").listFiles()!!.first() proguardFiles(it)
) }
} }
``` ```