Skip to content

Commit

Permalink
docs: 更新 API README
Browse files Browse the repository at this point in the history
  • Loading branch information
@afkT
afkT committed Jul 1, 2023
1 parent 70985ee commit eb7da86
Show file tree
Hide file tree
Showing 16 changed files with 165 additions and 118 deletions.
34 changes: 17 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<img alt="API" src="https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat" />
</a>
<a href="https://search.maven.org/search?q=io.github.afkt">
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.2-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.3-yellow.svg" />
</a>
<a href="https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md">
<img alt="Utils" src="https://img.shields.io/badge/Utils-300+-critical.svg" />
Expand Down Expand Up @@ -54,44 +54,44 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.4.2'
implementation 'io.github.afkt:DevAppX:2.4.3'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.3.8'
implementation 'io.github.afkt:DevAssist:1.3.9'
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
implementation 'io.github.afkt:DevBase:1.1.4'
implementation 'io.github.afkt:DevBase:1.1.5'
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
implementation 'io.github.afkt:DevBaseMVVM:1.1.2'
implementation 'io.github.afkt:DevBaseMVVM:1.1.3'
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
implementation 'io.github.afkt:DevEngine:1.1.0'
implementation 'io.github.afkt:DevEngine:1.1.1'
// DevHttpCapture - OkHttp 抓包工具库
implementation 'io.github.afkt:DevHttpCapture:1.1.3'
implementation 'io.github.afkt:DevHttpCapture:1.1.4'
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.3'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.3'
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.4'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.4'
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
implementation 'io.github.afkt:DevHttpManager:1.0.3'
implementation 'io.github.afkt:DevHttpManager:1.0.4'
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
implementation 'io.github.afkt:DevRetrofit:1.0.2'
implementation 'io.github.afkt:DevRetrofit:1.0.3'
// DevWidget - 自定义 View UI 库
implementation 'io.github.afkt:DevWidgetX:1.2.0'
implementation 'io.github.afkt:DevWidgetX:1.2.1'
// DevEnvironment - Android 环境配置切换库
implementation 'io.github.afkt:DevEnvironment:1.1.2'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.2' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kapt
implementation 'io.github.afkt:DevEnvironment:1.1.3'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.3' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.3' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.3' // kapt
// DevJava - Java 工具类库 ( 不依赖 android api )
implementation 'io.github.afkt:DevJava:1.4.8' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
implementation 'io.github.afkt:DevJava:1.4.9' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
```


Expand Down
34 changes: 17 additions & 17 deletions README_API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<img alt="API" src="https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat" />
</a>
<a href="https://search.maven.org/search?q=io.github.afkt">
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.2-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.3-yellow.svg" />
</a>
<a href="https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md">
<img alt="Utils" src="https://img.shields.io/badge/Utils-300+-critical.svg" />
Expand Down Expand Up @@ -170,44 +170,44 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.4.2'
implementation 'io.github.afkt:DevAppX:2.4.3'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.3.8'
implementation 'io.github.afkt:DevAssist:1.3.9'
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
implementation 'io.github.afkt:DevBase:1.1.4'
implementation 'io.github.afkt:DevBase:1.1.5'
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
implementation 'io.github.afkt:DevBaseMVVM:1.1.2'
implementation 'io.github.afkt:DevBaseMVVM:1.1.3'
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
implementation 'io.github.afkt:DevEngine:1.1.0'
implementation 'io.github.afkt:DevEngine:1.1.1'
// DevHttpCapture - OkHttp 抓包工具库
implementation 'io.github.afkt:DevHttpCapture:1.1.3'
implementation 'io.github.afkt:DevHttpCapture:1.1.4'
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.3'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.3'
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.4'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.4'
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
implementation 'io.github.afkt:DevHttpManager:1.0.3'
implementation 'io.github.afkt:DevHttpManager:1.0.4'
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
implementation 'io.github.afkt:DevRetrofit:1.0.2'
implementation 'io.github.afkt:DevRetrofit:1.0.3'
// DevWidget - 自定义 View UI 库
implementation 'io.github.afkt:DevWidgetX:1.2.0'
implementation 'io.github.afkt:DevWidgetX:1.2.1'
// DevEnvironment - Android 环境配置切换库
implementation 'io.github.afkt:DevEnvironment:1.1.2'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.2' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kapt
implementation 'io.github.afkt:DevEnvironment:1.1.3'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.3' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.3' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.3' // kapt
// DevJava - Java 工具类库 ( 不依赖 android api )
implementation 'io.github.afkt:DevJava:1.4.8' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
implementation 'io.github.afkt:DevJava:1.4.9' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
```


Expand Down
58 changes: 29 additions & 29 deletions file/gradle/versions.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,56 +26,56 @@ ext {
// ===========

// DevApp - Android 工具类库
dev_app_versionCode : 242,
dev_app_versionName : "2.4.2",
dev_app_versionCode : 243,
dev_app_versionName : "2.4.3",

// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
dev_assist_versionCode : 138,
dev_assist_versionName : "1.3.8",
dev_assist_versionCode : 139,
dev_assist_versionName : "1.3.9",

// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
dev_base_versionCode : 114,
dev_base_versionName : "1.1.4",
dev_base_versionCode : 115,
dev_base_versionName : "1.1.5",

// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
dev_base_mvvm_versionCode : 112,
dev_base_mvvm_versionName : "1.1.2",
dev_base_mvvm_versionCode : 113,
dev_base_mvvm_versionName : "1.1.3",

// DevMVVM - DataBinding 工具类库
dev_mvvm_versionCode : 100,
dev_mvvm_versionName : "1.0.0",
dev_mvvm_versionCode : 101,
dev_mvvm_versionName : "1.0.1",

// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
dev_engine_versionCode : 110,
dev_engine_versionName : "1.1.0",
dev_engine_versionCode : 111,
dev_engine_versionName : "1.1.1",

// DevHttpCapture - OkHttp 抓包工具库
dev_http_capture_versionCode : 113,
dev_http_capture_versionName : "1.1.3",
dev_http_capture_compiler_version : "1.1.3",
dev_http_capture_compiler_release_version: "1.1.3",
dev_http_capture_versionCode : 114,
dev_http_capture_versionName : "1.1.4",
dev_http_capture_compiler_version : "1.1.4",
dev_http_capture_compiler_release_version: "1.1.4",

// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
dev_http_manager_versionCode : 103,
dev_http_manager_versionName : "1.0.3",
dev_http_manager_versionCode : 104,
dev_http_manager_versionName : "1.0.4",

// DevRetrofit - Retrofit + Kotlin Coroutines 封装
dev_retrofit_versionCode : 102,
dev_retrofit_versionName : "1.0.2",
dev_retrofit_versionCode : 103,
dev_retrofit_versionName : "1.0.3",

// DevWidget - 自定义 View UI 库
dev_widget_versionCode : 120,
dev_widget_versionName : "1.2.0",
dev_widget_versionCode : 121,
dev_widget_versionName : "1.2.1",

// DevEnvironment - Android 环境配置切换库
dev_environment_versionCode : 112,
dev_environment_version : "1.1.2",
dev_environment_base_version : "1.1.2",
dev_environment_compiler_version : "1.1.2",
dev_environment_compiler_release_version : "1.1.2",
dev_environment_versionCode : 113,
dev_environment_version : "1.1.3",
dev_environment_base_version : "1.1.3",
dev_environment_compiler_version : "1.1.3",
dev_environment_compiler_release_version : "1.1.3",

// DevJava - Java 工具类库 ( 不依赖 android api )
dev_java_versionCode : 148,
dev_java_version : "1.4.8",
dev_java_versionCode : 149,
dev_java_version : "1.4.9",
]
}
17 changes: 16 additions & 1 deletion lib/DevApp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//implementation 'com.afkt:DevApp:1.9.4'
// AndroidX ( Maven Central )
implementation 'io.github.afkt:DevAppX:2.4.2'
implementation 'io.github.afkt:DevAppX:2.4.3'
```

## 目录结构
Expand Down Expand Up @@ -412,8 +412,11 @@ DevUtils.openDebug();
| uninstallApp | 卸载应用 |
| uninstallAppSilent | 静默卸载应用 |
| launchApp | 打开 APP |
| launchApp2 | 打开 APP |
| launchAppDetailsSettings | 跳转到 APP 设置详情页面 |
| launchAppDetails | 跳转到 APP 应用商城详情页面 |
| launchAppInstallPermissionSettings | 跳转设置页面, 开启安装未知应用权限 |
| launchManageAppAllFilesAccessPermission | 跳转设置页面, 开启 APP 授予所有文件管理权限 |
| openFile | 打开文件 |
| openFileByApp | 打开文件 ( 指定应用 ) |
| openPDFFile | 打开 PDF 文件 |
Expand Down Expand Up @@ -557,6 +560,7 @@ DevUtils.openDebug();
| :- | :- |
| addTouchArea | 增加控件的触摸范围, 最大范围只能是父布局所包含的的区域 |
| setCheckViewId | 设置全局是否校验 viewId |
| getGlobalIntervalTime | 获取全局双击间隔时间 |
| setGlobalIntervalTime | 设置全局双击间隔时间 |
| get | 获取对应功能模块点击辅助类 |
| remove | 移除对应功能模块点击辅助类 |
Expand All @@ -567,6 +571,7 @@ DevUtils.openDebug();
| getConfigTime | 获取配置时间 |
| removeRecord | 移除点击记录 |
| clearRecord | 清空全部点击记录 |
| getIntervalTime | 获取默认点击时间间隔 |
| setIntervalTime | 设置默认点击时间间隔 |
| reset | 重置处理 |
| setOnClick | 设置点击事件 |
Expand Down Expand Up @@ -990,6 +995,8 @@ DevUtils.openDebug();
| :- | :- |
| isGpsEnabled | 判断 GPS 是否可用 |
| isLocationEnabled | 判断定位是否可用 |
| isLocationEnabled2 | 判断定位是否可用 |
| isPassiveEnable | 判断定位是否可用 |
| openGpsSettings | 打开 GPS 设置界面 |
| register | 注册 |
| unregister | 注销监听 |
Expand Down Expand Up @@ -1906,6 +1913,8 @@ DevUtils.openDebug();
| isQ | 是否在 10.0 版本及以上 |
| isR | 是否在 11.0 版本及以上 |
| isS | 是否在 12.0 版本及以上 |
| isSV2 | 是否在 12.0 L 版本及以上 |
| isTiramisu | 是否在 13.0 版本及以上 |
| convertSDKVersion | 转换 SDK 版本 convertSDKVersion(31) = Android 12.0 |
| convertSDKVersionName | 转换 SDK 版本名字 convertSDKVersionName(31) = Android S |

Expand Down Expand Up @@ -4337,6 +4346,8 @@ DevUtils.openDebug();
| getAppPermissionToSet | 获取 APP 注册的权限 |
| getAppPermission | 获取 APP 注册的权限 |
| printAppPermission | 打印 APP 注册的权限 |
| getAllLauncherIconPackages | 获取所有能够显示在桌面上的应用 |
| getAllLauncherIconPackageNames | 获取所有能够显示在桌面上的应用包名 |


* **键对值实体类 ->** [KeyValue.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/info/KeyValue.java)
Expand Down Expand Up @@ -5299,6 +5310,10 @@ DevUtils.openDebug();
| :- | :- |
| forArgs | 循环可变数组 |
| forSimpleArgs | 循环可变数组 |
| forList | 循环集合 |
| forListIterator | 循环集合 |
| forSet | 循环集合 |
| forMap | 循环集合 |
| forInts | 循环可变数组 |
| forDoubles | 循环可变数组 |
| forFloats | 循环可变数组 |
Expand Down
2 changes: 1 addition & 1 deletion lib/DevAssist/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevAssist:1.3.8'
implementation 'io.github.afkt:DevAssist:1.3.9'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevBase/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevBase:1.1.4'
implementation 'io.github.afkt:DevBase:1.1.5'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevBaseMVVM/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevBaseMVVM:1.1.2'
implementation 'io.github.afkt:DevBaseMVVM:1.1.3'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevEngine/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevEngine:1.1.0'
implementation 'io.github.afkt:DevEngine:1.1.1'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevHttpCapture/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevHttpCapture:1.1.3'
implementation 'io.github.afkt:DevHttpCapture:1.1.4'
```

## 目录结构
Expand Down
8 changes: 4 additions & 4 deletions lib/DevHttpManager/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevHttpManager:1.0.3'
implementation 'io.github.afkt:DevHttpManager:1.0.4'
```

## 目录结构
Expand Down Expand Up @@ -410,15 +410,15 @@ private fun buildRetrofit(httpUrl: HttpUrl? = null): RetrofitOperation {
RetrofitManager.getRetrofitResetListener()?.onResetBefore(
key, mRetrofit
)
} catch (ignored: Exception) {
} catch (e: Exception) {
}
builder.onResetBefore(key, mRetrofit)
}

// 获取全局 OkHttp Builder
val okHttpBuilder = try {
RetrofitManager.getOkHttpBuilder()?.createOkHttpBuilder(key)
} catch (ignored: Exception) {
} catch (e: Exception) {
null
}
// 可以通过 mRetrofit?.baseUrl() 获取之前的配置
Expand All @@ -432,7 +432,7 @@ private fun buildRetrofit(httpUrl: HttpUrl? = null): RetrofitOperation {
RetrofitManager.getRetrofitResetListener()?.onReset(
key, mRetrofit
)
} catch (ignored: Exception) {
} catch (e: Exception) {
}
}
// 首次为初始化, 后续操作为重置操作
Expand Down
Loading

0 comments on commit eb7da86

Please sign in to comment.