Skip to content

Commit 98be6d2

Browse files
committed
docs: 更新 API 文档
Former-commit-id: 3eb5288 Former-commit-id: aecd3dd
1 parent 550830e commit 98be6d2

File tree

5 files changed

+43
-78
lines changed

5 files changed

+43
-78
lines changed

README.md

Lines changed: 3 additions & 3 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.8-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
4+
[![MavenCentral](https://img.shields.io/badge/DevUtils-2.3.9-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,7 +113,7 @@
113113
```gradle
114114
115115
// DevApp - Android 工具类库
116-
implementation 'io.github.afkt:DevAppX:2.3.8'
116+
implementation 'io.github.afkt:DevAppX:2.3.9'
117117
118118
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
119119
implementation 'io.github.afkt:DevAssist:1.3.5'
@@ -150,7 +150,7 @@ releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0'
150150
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kapt
151151
152152
// DevJava - Java 工具类库 ( 不依赖 android api )
153-
implementation 'io.github.afkt:DevJava:1.4.4' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
153+
implementation 'io.github.afkt:DevJava:1.4.5' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
154154
```
155155

156156
## [APK Demo](https://github.com/afkT/Resources/blob/main/APK)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4f9a176aa88cb66842c3d61df007b961c8437844
1+
1abdec9369f50098c0dd6432d3a47c473bcf3a40

lib/DevEngine/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,18 @@ implementation 'io.github.afkt:DevEngine:1.0.7'
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-
- permission | Permission Engine 权限申请
21-
- 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+
- luck_lib_engine | LuckSiege PictureSelector Engine 实现
21+
- permission | Permission Engine 权限申请
22+
- storage | Storage Engine 外部、内部文件存储
2223
```
2324

2425

lib/DevJava/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:DevJava:1.4.4'
5+
implementation 'io.github.afkt:DevJava:1.4.5'
66
```
77

88
## 目录结构
@@ -923,6 +923,7 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
923923
| length | 获取字符串长度 |
924924
| isLength | 获取字符串长度 是否等于期望长度 |
925925
| equals | 判断两个值是否一样 |
926+
| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
926927
| isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
927928
| isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
928929
| isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |

lib/LocalModules/DevOther/README.md

Lines changed: 25 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- keyvalue | KeyValue Engine 键值对存储
2020
- log | Log Engine 日志打印
2121
- media | Media Selector Engine 多媒体资源选择
22+
- luck_lib_engine| LuckSiege PictureSelector Engine 实现
2223
- permission | Permission Engine 权限申请
2324
- storage | Storage Engine 外部、内部文件存储
2425
- other | 第三方库封装工具类
@@ -64,6 +65,7 @@
6465
- [keyvalue](#javadevenginekeyvalue) | KeyValue Engine 键值对存储
6566
- [log](#javadevenginelog) | Log Engine 日志打印
6667
- [media](#javadevenginemedia) | Media Selector Engine 多媒体资源选择
68+
- [luck_lib_engine](#javadevenginemedialuck_lib_engine)| LuckSiege PictureSelector Engine 实现
6769
- [permission](#javadevenginepermission) | Permission Engine 权限申请
6870
- [storage](#javadevenginestorage) | Storage Engine 外部、内部文件存储
6971
- [other](#javadevother) | 第三方库封装工具类
@@ -527,16 +529,6 @@
527529
## <span id="javadevenginemedia">**`java.dev.engine.media`**</span>
528530

529531

530-
* ** ->** [GlideEngine.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/GlideEngine.java)
531-
532-
| 方法 | 注释 |
533-
| :- | :- |
534-
| loadImage | 加载图片 |
535-
| loadFolderImage | 加载相册目录 |
536-
| loadGridImage | 加载图片列表图片 |
537-
| createGlideEngine | createGlideEngine |
538-
539-
540532
* **Local Media Selector Data ->** [LocalMediaData.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/LocalMediaData.java)
541533

542534
| 方法 | 注释 |
@@ -610,6 +602,19 @@
610602
| getSingleSelectorPath | getSingleSelectorPath |
611603

612604

605+
## <span id="javadevenginemedialuck_lib_engine">**`java.dev.engine.media.luck_lib_engine`**</span>
606+
607+
608+
* ** ->** [LuckGlideEngineImpl.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/luck_lib_engine/LuckGlideEngineImpl.java)
609+
610+
| 方法 | 注释 |
611+
| :- | :- |
612+
| loadImage | 加载图片 |
613+
| loadFolderImage | 加载相册目录 |
614+
| loadGridImage | 加载图片列表图片 |
615+
| createGlideEngine | createGlideEngine |
616+
617+
613618
## <span id="javadevenginepermission">**`java.dev.engine.permission`**</span>
614619

615620

@@ -732,15 +737,6 @@
732737
| getType | 获取 Type |
733738

734739

735-
* **Glide 图形处理工具类 ->** [GlideTransformUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/GlideTransformUtils.java)
736-
737-
| 方法 | 注释 |
738-
| :- | :- |
739-
| transform | transform |
740-
| updateDiskCacheKey | updateDiskCacheKey |
741-
| blurBitmap | 模糊图片处理 |
742-
743-
744740
* **Glide 工具类 ->** [GlideUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/GlideUtils.java)
745741

746742
| 方法 | 注释 |
@@ -861,55 +857,22 @@
861857

862858
| 方法 | 注释 |
863859
| :- | :- |
864-
| getConfig | 获取全局相册配置 |
865-
| setConfig | 设置全局相册配置 |
860+
| openCamera | 打开相册拍照 |
861+
| openGallery | 打开相册选择 |
862+
| getConfig | 获取全局配置 |
863+
| setConfig | 设置全局配置 |
866864
| getCameraSavePath | 获取拍照存储地址 |
867865
| getCompressSavePath | 获取压缩图片存储地址 |
868866
| setSavePath | 设置存储地址 |
869867
| getMinimumCompressSize | 获取图片大于多少才进行压缩 ( kb ) |
870868
| setMinimumCompressSize | 设置图片大于多少才进行压缩 ( kb ) |
871-
| deleteCacheDirFile | 清空缓存 |
872-
| deleteAllCacheDirFile | 清空全部缓存 |
869+
| deleteCacheDirFile | 删除缓存文件 |
870+
| deleteAllCacheDirFile | 删除全部缓存文件 |
873871
| isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |
874-
| getLocalMedias | 获取选中的资源集合 |
875-
| getSingleMedia | 获取单独选中的资源 |
876-
| getLocalMediaPath | 获取本地资源路径 |
877-
| getLocalMediaPaths | 获取本地资源地址集合 |
878-
| getPictureSelectionModel | 获取图片选择配置模型 |
879-
| openCamera | 打开相册拍照 |
880-
| openGallery | 打开相册选择 |
881-
| getMimeType | 获取相册选择类型 |
882-
| setMimeType | 设置相册选择类型 |
883-
| getSelectionMode | 获取相册选择模式 |
884-
| setSelectionMode | 设置相册选择模式 |
885-
| isCamera | 是否显示拍照 |
886-
| setCamera | 设置是否显示拍照 |
887-
| isCrop | 是否裁减 |
888-
| setCrop | 设置是否裁减 |
889-
| isCircleCrop | 是否圆形裁减 |
890-
| setCircleCrop | 设置是否圆形裁减 |
891-
| isCompress | 是否压缩 |
892-
| setCompress | 设置是否压缩 |
893-
| getWithAspectRatio | 获取裁减比例 |
894-
| setWithAspectRatio | 设置裁减比例 |
895-
| isGif | 是否显示 Gif |
896-
| setGif | 设置是否显示 Gif |
897-
| getImageSpanCount | 获取每行显示个数 |
898-
| setImageSpanCount | 设置每行显示个数 |
899-
| getMinSelectNum | 获取最小选择数量 |
900-
| setMinSelectNum | 设置最小选择数量 |
901-
| getMaxSelectNum | 获取最大选择数量 |
902-
| setMaxSelectNum | 设置最大选择数量 |
903-
| getLocalMedia | 获取已选择的本地资源 |
904-
| setLocalMedia | 设置已选择的本地资源 |
905-
| setCameraSavePath | 设置拍照存储地址 |
906-
| setCompressSavePath | 设置压缩图片存储地址 |
907-
| clone | 克隆新的配置信息 |
908-
| set | 设置新的配置信息 |
909-
| ofAll | ofAll |
910-
| ofImage | ofImage |
911-
| ofVideo | ofVideo |
912-
| ofAudio | ofAudio |
872+
| getSelectors | 获取 Media Selector Data List |
873+
| getSelectorPaths | 获取 Media Selector Path List |
874+
| getSingleSelector | 获取 Single Media Selector Data |
875+
| getSingleSelectorPath | 获取 Single Media Selector Path |
913876

914877

915878
* **ZXing 条形码、二维码工具类 ->** [ZXingUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/ZXingUtils.java)

0 commit comments

Comments
 (0)