Skip to content

Commit be53414

Browse files
afkTafkT
committed
docs: 更新 DevUtils 所有库 API 文档
Former-commit-id: 8271105 Former-commit-id: 75b179d
1 parent 4030147 commit be53414

File tree

15 files changed

+287
-205
lines changed

15 files changed

+287
-205
lines changed

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
[![GitHub](https://img.shields.io/badge/GitHub-afkT-blue.svg)](https://github.com/afkT)
33
[![GitHub license](https://img.shields.io/github/license/afkT/DevUtils.svg)](https://github.com/afkT/DevUtils/blob/master/LICENSE)
4-
[![MavenCentral](https://img.shields.io/badge/DevUtils-2.3.9-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
4+
[![MavenCentral](https://img.shields.io/badge/DevUtils-2.4.0-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
55
[![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)
66
[![Utils](https://img.shields.io/badge/utils-200+-ff69b4.svg)](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md)
77

@@ -113,44 +113,44 @@
113113
```gradle
114114
115115
// DevApp - Android 工具类库
116-
implementation 'io.github.afkt:DevAppX:2.3.9'
116+
implementation 'io.github.afkt:DevAppX:2.4.0'
117117
118118
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
119-
implementation 'io.github.afkt:DevAssist:1.3.5'
119+
implementation 'io.github.afkt:DevAssist:1.3.6'
120120
121121
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
122-
implementation 'io.github.afkt:DevBase:1.1.2'
122+
implementation 'io.github.afkt:DevBase:1.1.3'
123123
124124
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
125-
implementation 'io.github.afkt:DevBaseMVVM:1.1.0'
125+
implementation 'io.github.afkt:DevBaseMVVM:1.1.1'
126126
127127
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
128-
implementation 'io.github.afkt:DevEngine:1.0.7'
128+
implementation 'io.github.afkt:DevEngine:1.0.8'
129129
130130
// DevHttpCapture - OkHttp 抓包工具库
131-
implementation 'io.github.afkt:DevHttpCapture:1.1.1'
131+
implementation 'io.github.afkt:DevHttpCapture:1.1.2'
132132
133133
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
134-
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.1'
135-
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.1'
134+
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.2'
135+
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.2'
136136
137137
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
138-
implementation 'io.github.afkt:DevHttpManager:1.0.1'
138+
implementation 'io.github.afkt:DevHttpManager:1.0.2'
139139
140140
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
141-
implementation 'io.github.afkt:DevRetrofit:1.0.0'
141+
implementation 'io.github.afkt:DevRetrofit:1.0.1'
142142
143143
// DevWidget - 自定义 View UI 库
144-
implementation 'io.github.afkt:DevWidgetX:1.1.8'
144+
implementation 'io.github.afkt:DevWidgetX:1.1.9'
145145
146146
// DevEnvironment - Android 环境配置切换库
147-
implementation 'io.github.afkt:DevEnvironment:1.1.0'
148-
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kaptDebug
149-
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0' // kaptRelease
150-
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kapt
147+
implementation 'io.github.afkt:DevEnvironment:1.1.1'
148+
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1' // kaptDebug
149+
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.1' // kaptRelease
150+
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1' // kapt
151151
152152
// DevJava - Java 工具类库 ( 不依赖 android api )
153-
implementation 'io.github.afkt:DevJava:1.4.5' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
153+
implementation 'io.github.afkt:DevJava:1.4.6' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
154154
```
155155

156156
## [APK Demo](https://github.com/afkT/Resources/blob/main/APK)

‎lib/DevApp/README.md.REMOVED.git-id‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1abdec9369f50098c0dd6432d3a47c473bcf3a40
1+
5575816badfc7f4fca58369ab4daa6c9faa8ba7a

‎lib/DevAssist/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevAssist:1.3.5'
5+
implementation 'io.github.afkt:DevAssist:1.3.6'
66
```
77

88
## 目录结构
@@ -1426,6 +1426,7 @@ implementation 'io.github.afkt:DevAssist:1.3.5'
14261426
| setConfig | 设置全局配置 |
14271427
| openCamera | 打开相册拍照 |
14281428
| openGallery | 打开相册选择 |
1429+
| openPreview | 打开相册预览 |
14291430
| deleteCacheDirFile | 删除缓存文件 |
14301431
| deleteAllCacheDirFile | 删除全部缓存文件 |
14311432
| isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |

‎lib/DevBase/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevBase:1.1.2'
5+
implementation 'io.github.afkt:DevBase:1.1.3'
66
```
77

88
## 目录结构

‎lib/DevBaseMVVM/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevBaseMVVM:1.1.0'
5+
implementation 'io.github.afkt:DevBaseMVVM:1.1.1'
66
```
77

88
## 目录结构

‎lib/DevEngine/README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,23 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevEngine:1.0.7'
5+
implementation 'io.github.afkt:DevEngine:1.0.8'
66
```
77

88
## 目录结构
99

1010
```
11-
- dev.engine | 根目录
12-
- barcode | BarCode Engine 条形码、二维码处理
13-
- cache | Cache Engine 有效期键值对缓存
14-
- compress | Image Compress Engine 图片压缩
15-
- image | Image Engine 图片加载、下载、转格式等
16-
- json | JSON Engine 映射
17-
- keyvalue | KeyValue Engine 键值对存储
18-
- log | Log Engine 日志打印
19-
- media | Media Selector Engine 多媒体资源选择
20-
- luck_lib_engine | LuckSiege PictureSelector Engine 实现
21-
- permission | Permission Engine 权限申请
22-
- storage | Storage Engine 外部、内部文件存储
11+
- dev.engine | 根目录
12+
- barcode | BarCode Engine 条形码、二维码处理
13+
- cache | Cache Engine 有效期键值对缓存
14+
- compress | Image Compress Engine 图片压缩
15+
- image | Image Engine 图片加载、下载、转格式等
16+
- json | JSON Engine 映射
17+
- keyvalue | KeyValue Engine 键值对存储
18+
- log | Log Engine 日志打印
19+
- media | Media Selector Engine 多媒体资源选择
20+
- permission | Permission Engine 权限申请
21+
- storage | Storage Engine 外部、内部文件存储
2322
```
2423

2524

@@ -311,27 +310,26 @@ private fun initEngine(appContext: Application) {
311310

312311
## API
313312

314-
- dev | 根目录
315-
- [engine](#devengine) | 兼容 Engine
316-
- [analytics](#devengineanalytics) | Analytics Engine 数据统计 ( 埋点 )
317-
- [barcode](#devenginebarcode) | BarCode Engine 条形码、二维码处理
318-
- [listener](#devenginebarcodelistener) | 条形码、二维码操作回调事件
319-
- [cache](#devenginecache) | Cache Engine 有效期键值对缓存
320-
- [compress](#devenginecompress) | Image Compress Engine 图片压缩
321-
- [listener](#devenginecompresslistener) | 图片压缩回调事件
322-
- [image](#devengineimage) | Image Engine 图片加载、下载、转格式等
323-
- [listener](#devengineimagelistener) | 图片加载监听事件
324-
- [json](#devenginejson) | JSON Engine 映射
325-
- [keyvalue](#devenginekeyvalue) | KeyValue Engine 键值对存储
326-
- [log](#devenginelog) | Log Engine 日志打印
327-
- [media](#devenginemedia) | Media Selector Engine 多媒体资源选择
328-
- [permission](#devenginepermission) | Permission Engine 权限申请
329-
- [push](#devenginepush) | Push Engine 推送平台处理
330-
- [share](#devengineshare) | Share Engine 分享平台处理
331-
- [listener](#devenginesharelistener) | 分享回调事件
332-
- [storage](#devenginestorage) | Storage Engine 外部、内部文件存储
333-
- [listener](#devenginestoragelistener) | Storage 存储结果事件
334-
313+
- dev | 根目录
314+
- [engine](#devengine) | 兼容 Engine
315+
- [analytics](#devengineanalytics) | Analytics Engine 数据统计 ( 埋点 )
316+
- [barcode](#devenginebarcode) | BarCode Engine 条形码、二维码处理
317+
- [listener](#devenginebarcodelistener) | 条形码、二维码操作回调事件
318+
- [cache](#devenginecache) | Cache Engine 有效期键值对缓存
319+
- [compress](#devenginecompress) | Image Compress Engine 图片压缩
320+
- [listener](#devenginecompresslistener) | 图片压缩回调事件
321+
- [image](#devengineimage) | Image Engine 图片加载、下载、转格式等
322+
- [listener](#devengineimagelistener) | 图片加载监听事件
323+
- [json](#devenginejson) | JSON Engine 映射
324+
- [keyvalue](#devenginekeyvalue) | KeyValue Engine 键值对存储
325+
- [log](#devenginelog) | Log Engine 日志打印
326+
- [media](#devenginemedia) | Media Selector Engine 多媒体资源选择
327+
- [permission](#devenginepermission) | Permission Engine 权限申请
328+
- [push](#devenginepush) | Push Engine 推送平台处理
329+
- [share](#devengineshare) | Share Engine 分享平台处理
330+
- [listener](#devenginesharelistener) | 分享回调事件
331+
- [storage](#devenginestorage) | Storage Engine 外部、内部文件存储
332+
- [listener](#devenginestoragelistener) | Storage 存储结果事件
335333

336334

337335

@@ -736,6 +734,7 @@ private fun initEngine(appContext: Application) {
736734
| setConfig | 设置全局配置 |
737735
| openCamera | 打开相册拍照 |
738736
| openGallery | 打开相册选择 |
737+
| openPreview | 打开相册预览 |
739738
| deleteCacheDirFile | 删除缓存文件 |
740739
| deleteAllCacheDirFile | 删除全部缓存文件 |
741740
| isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |
@@ -833,10 +832,11 @@ private fun initEngine(appContext: Application) {
833832
| shareMinApp | 分享小程序 |
834833
| shareUrl | 分享链接 |
835834
| shareImage | 分享图片 |
835+
| shareImageList | 分享多张图片 |
836+
| shareText | 分享文本 |
836837
| shareVideo | 分享视频 |
837838
| shareMusic | 分享音乐 |
838839
| shareEmoji | 分享表情 |
839-
| shareText | 分享文本 |
840840
| shareFile | 分享文件 |
841841
| share | 分享操作 ( 通用扩展 ) |
842842
| onActivityResult | 部分平台 Activity onActivityResult 额外调用处理 |

‎lib/DevHttpCapture/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevHttpCapture:1.1.1'
5+
implementation 'io.github.afkt:DevHttpCapture:1.1.2'
66
```
77

88
## 目录结构

‎lib/DevHttpManager/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
## Gradle
1313

1414
```gradle
15-
implementation 'io.github.afkt:DevHttpManager:1.0.1'
15+
implementation 'io.github.afkt:DevHttpManager:1.0.2'
1616
```
1717

1818
## 目录结构

‎lib/DevJava/README.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Gradle
33

44
```gradle
5-
implementation 'io.github.afkt:DevJava:1.4.5'
5+
implementation 'io.github.afkt:DevJava:1.4.6'
66
```
77

88
## 目录结构
@@ -924,6 +924,8 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
924924
| isLength | 获取字符串长度 是否等于期望长度 |
925925
| equals | 判断两个值是否一样 |
926926
| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
927+
| equalsIgnoreCase | 判断两个值是否一样 ( 忽略大小写 ) |
928+
| equalsIgnoreCaseNotNull | 判断两个值是否一样 ( 忽略大小写 ) |
927929
| isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
928930
| isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
929931
| isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |
@@ -1809,14 +1811,16 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
18091811
| isContainChinese | 判断字符串中包含中文、包括中文字符标点等 |
18101812

18111813

1812-
* **检验联系 ( 手机号、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)
1814+
* **检验联系 ( 手机号码、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)
18131815

18141816
| 方法 | 注释 |
18151817
| :- | :- |
1816-
| isPhoneCheck | 中国手机号格式验证, 在输入可以调用该方法, 点击发送验证码, 使用 isPhone |
1817-
| isPhone | 是否中国手机号 |
1818-
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
1819-
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
1818+
| isPhoneSimple | 中国手机号码格式验证 ( 简单手机号码校验 ) |
1819+
| isPhone | 是否中国手机号码 |
18201820
| isPhoneToChinaMobile | 是否中国移动手机号码 |
1821-
| isPhoneToHkMobile | 判断是否香港手机号 |
1821+
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
1822+
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
1823+
| isPhoneToChinaBroadcast | 是否中国广电手机号码 |
1824+
| isPhoneToChinaVirtual | 是否中国虚拟运营商手机号码 |
1825+
| isPhoneToChinaHkMobile | 是否中国香港手机号码 |
18221826
| isPhoneCallNum | 验证电话号码的格式 |

‎lib/DevRetrofit/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
## Gradle
1313

1414
```gradle
15-
implementation 'io.github.afkt:DevRetrofit:1.0.0'
15+
implementation 'io.github.afkt:DevRetrofit:1.0.1'
1616
```
1717

1818
## 框架功能介绍

0 commit comments

Comments
 (0)