Skip to content

Commit

Permalink
docs: 更新部分版本信息、忽略配置
Browse files Browse the repository at this point in the history
  • Loading branch information
afkT committed May 15, 2024
1 parent 7534f3c commit be67d06
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 108 deletions.
4 changes: 2 additions & 2 deletions API/README.md
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-19%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.5-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.6-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,7 +54,7 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.4.5'
implementation 'io.github.afkt:DevAppX:2.4.6'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.4.1'
Expand Down
4 changes: 2 additions & 2 deletions API/README_API.md
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-19%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.5-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.6-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,7 +170,7 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.4.5'
implementation 'io.github.afkt:DevAppX:2.4.6'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.4.1'
Expand Down
4 changes: 2 additions & 2 deletions API/README_ORIGINAL.md
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-19%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.5-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.6-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,7 +170,7 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.4.5'
implementation 'io.github.afkt:DevAppX:2.4.6'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.4.1'
Expand Down
56 changes: 54 additions & 2 deletions API/lib/DevApp/README.md
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.5'
implementation 'io.github.afkt:DevAppX:2.4.6'
```

## 目录结构
Expand All @@ -20,6 +20,8 @@ implementation 'io.github.afkt:DevAppX:2.4.5'
- exif | 图片 EXIF 读写辅助类
- floating | 悬浮窗实现方案辅助类
- lifecycle | Activity 生命周期监听辅助类
- current | 当前 Activity、Fragment 生命周期辅助类
- fragment | Fragment 生命周期辅助类
- record | 文件记录分析类
- url | Url 携带信息解析
- cache | 缓存工具类
Expand Down Expand Up @@ -111,6 +113,8 @@ DevUtils.openDebug();
- [exif](#devutilsappassistexif) | 图片 EXIF 读写辅助类
- [floating](#devutilsappassistfloating) | 悬浮窗实现方案辅助类
- [lifecycle](#devutilsappassistlifecycle) | Activity 生命周期监听辅助类
- [current](#devutilsappassistlifecyclecurrent) | 当前 Activity、Fragment 生命周期辅助类
- [fragment](#devutilsappassistlifecyclefragment) | Fragment 生命周期辅助类
- [record](#devutilsappassistrecord) | 文件记录分析类
- [url](#devutilsappassisturl) | Url 携带信息解析
- [cache](#devutilsappcache) | 缓存工具类
Expand Down Expand Up @@ -2765,7 +2769,7 @@ DevUtils.openDebug();
## <span id="devutilsappassistlifecycle">**`dev.utils.app.assist.lifecycle`**</span>


* **ActivityLifecycleCallbacks 抽象类 ->** [AbstractActivityLifecycle.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/lifecycle/AbstractActivityLifecycle.java)
* **Activity LifecycleCallbacks 抽象类 ->** [AbstractActivityLifecycle.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/lifecycle/AbstractActivityLifecycle.java)

| 方法 | 注释 |
| :- | :- |
Expand Down Expand Up @@ -2835,6 +2839,41 @@ DevUtils.openDebug();
| onBackground | 切换到后台 |


## <span id="devutilsappassistlifecyclecurrent">**`dev.utils.app.assist.lifecycle.current`**</span>


* **当前 Activity 生命周期辅助类 ->** [ThisActivityLifecycleAssist.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/lifecycle/current/ThisActivityLifecycleAssist.java)

| 方法 | 注释 |
| :- | :- |
| ofListener | 获取 Activity 生命周期通知事件 |
| addListener | 添加 Activity 生命周期通知事件 |
| removeListener | 移除 Activity 生命周期通知事件 |
| removeAllListener | 移除全部 Activity 生命周期通知事件 |
| registerActivityLifecycleCallbacks | 注册绑定 Activity 生命周期事件处理 |
| unregisterActivityLifecycleCallbacks | 解除注册 Activity 生命周期事件处理 |


## <span id="devutilsappassistlifecyclefragment">**`dev.utils.app.assist.lifecycle.fragment`**</span>


* **Fragment 生命周期辅助类 ->** [FragmentLifecycleAssist.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/lifecycle/fragment/FragmentLifecycleAssist.java)

| 方法 | 注释 |
| :- | :- |
| setFragmentLifecycleFilter | 设置 Fragment 生命周期 过滤判断接口 |
| setAbstractFragmentLifecycle | 设置 FragmentLifecycle 监听回调 |
| registerFragmentLifecycleCallbacks | 注册绑定 Fragment 生命周期事件处理 |
| unregisterFragmentLifecycleCallbacks | 解除注册 Fragment 生命周期事件处理 |


* **Fragment 生命周期 过滤判断接口 ->** [FragmentLifecycleFilter.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/lifecycle/fragment/FragmentLifecycleFilter.java)

| 方法 | 注释 |
| :- | :- |
| filter | 判断是否过滤该类 ( 不进行添加等操作 ) |


## <span id="devutilsappassistrecord">**`dev.utils.app.assist.record`**</span>


Expand Down Expand Up @@ -5811,6 +5850,19 @@ DevUtils.openDebug();
| notHasFlags | 是否不存在 flags value |


* **键值对 Assist ->** [KeyValueAssist.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/assist/KeyValueAssist.java)

| 方法 | 注释 |
| :- | :- |
| getValue | 获取 Value |
| setValue | 设置 Value |
| removeValue | 移除 Value |
| getKeyValueMaps | 获取 Key Value Map |
| containsKey | 是否存在 Key |
| containsValue | 是否存在 Value |
| isEmpty | 判断 Value 是否为 null |


* **时间均值计算辅助类 ->** [TimeAverager.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/assist/TimeAverager.java)

| 方法 | 注释 |
Expand Down
13 changes: 13 additions & 0 deletions API/lib/DevJava/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1083,6 +1083,19 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
| notHasFlags | 是否不存在 flags value |


* **键值对 Assist ->** [KeyValueAssist.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/assist/KeyValueAssist.java)

| 方法 | 注释 |
| :- | :- |
| getValue | 获取 Value |
| setValue | 设置 Value |
| removeValue | 移除 Value |
| getKeyValueMaps | 获取 Key Value Map |
| containsKey | 是否存在 Key |
| containsValue | 是否存在 Value |
| isEmpty | 判断 Value 是否为 null |


* **时间均值计算辅助类 ->** [TimeAverager.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/assist/TimeAverager.java)

| 方法 | 注释 |
Expand Down
1 change: 0 additions & 1 deletion src/main/java/javadoc/dev_utils/readme/Dev_READMEMain.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package javadoc.dev_utils.readme;

import java.io.File;
import java.text.MessageFormat;

import dev.utils.common.FileUtils;
import javadoc.dev_utils.ApiConfig;
Expand Down
25 changes: 2 additions & 23 deletions src/main/java/javadoc/dev_utils/readme/Dev_READMEMain_API.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package javadoc.dev_utils.readme;

import java.io.File;
import java.text.MessageFormat;

import dev.utils.common.FileUtils;
import javadoc.dev_utils.ApiConfig;
Expand All @@ -25,28 +24,8 @@ public static String createREADME() {
byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README_API);
String templateContent = new String(bytes);

// 保存 README 内容
builder.append(MessageFormat.format(
// MessageFormat 会移除单引号, 所以需要加上双引号处理
templateContent.replaceAll("'", "''"),
ApiConfig.DEV_APP_VERSION,
ApiConfig.DEV_APP_VERSION,
ApiConfig.DEV_ASSIST_VERSION,
ApiConfig.DEV_BASE_VERSION,
ApiConfig.DEV_BASE_MVVM_VERSION,
ApiConfig.DEV_ENGINE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_MANAGER_VERSION,
ApiConfig.DEV_RETROFIT_VERSION,
ApiConfig.DEV_WIDGET_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_JAVA_VERSION
));
// 格式化 README 全部版本内容
builder.append(ApiConfig.formatAllVersion(templateContent));

// 保存 README
FileUtils.saveFile(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
package javadoc.dev_utils.readme;

import java.io.File;
import java.text.MessageFormat;

import dev.utils.common.FileUtils;
import javadoc.dev_utils.ApiConfig;

import java.io.File;

/**
* detail: 创建 README Main 方法
* @author Ttt
Expand All @@ -25,28 +24,8 @@ public static String createREADME() {
byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README_ORIGINAL);
String templateContent = new String(bytes);

// 保存 README 内容
builder.append(MessageFormat.format(
// MessageFormat 会移除单引号, 所以需要加上双引号处理
templateContent.replaceAll("'", "''"),
ApiConfig.DEV_APP_VERSION,
ApiConfig.DEV_APP_VERSION,
ApiConfig.DEV_ASSIST_VERSION,
ApiConfig.DEV_BASE_VERSION,
ApiConfig.DEV_BASE_MVVM_VERSION,
ApiConfig.DEV_ENGINE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_CAPTURE_VERSION,
ApiConfig.DEV_HTTP_MANAGER_VERSION,
ApiConfig.DEV_RETROFIT_VERSION,
ApiConfig.DEV_WIDGET_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_ENVIRONMENT_VERSION,
ApiConfig.DEV_JAVA_VERSION
));
// 格式化 README 全部版本内容
builder.append(ApiConfig.formatAllVersion(templateContent));

// 保存 README
FileUtils.saveFile(
Expand Down
34 changes: 17 additions & 17 deletions src/main/java/javadoc/dev_utils/readme/template/DEV_README_API.md
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-19%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-{0}-yellow.svg" />
<img alt="Version" src="https://img.shields.io/badge/DevUtils-【DevApp-vn】-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:{1}'
implementation 'io.github.afkt:DevAppX:【DevApp-vn】'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:{2}'
implementation 'io.github.afkt:DevAssist:【DevAssist-vn】'
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
implementation 'io.github.afkt:DevBase:{3}'
implementation 'io.github.afkt:DevBase:【DevBase-vn】'
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
implementation 'io.github.afkt:DevBaseMVVM:{4}'
implementation 'io.github.afkt:DevBaseMVVM:【DevBaseMVVM-vn】'
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
implementation 'io.github.afkt:DevEngine:{5}'
implementation 'io.github.afkt:DevEngine:【DevEngine-vn】'
// DevHttpCapture - OkHttp 抓包工具库
implementation 'io.github.afkt:DevHttpCapture:{6}'
implementation 'io.github.afkt:DevHttpCapture:【DevHttpCapture-vn】'
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:{7}'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:{8}'
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:【DevHttpCapture-vn】'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:【DevHttpCapture-vn】'
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
implementation 'io.github.afkt:DevHttpManager:{9}'
implementation 'io.github.afkt:DevHttpManager:【DevHttpManager-vn】'
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
implementation 'io.github.afkt:DevRetrofit:{10}'
implementation 'io.github.afkt:DevRetrofit:【DevRetrofit-vn】'
// DevWidget - 自定义 View UI 库
implementation 'io.github.afkt:DevWidgetX:{11}'
implementation 'io.github.afkt:DevWidgetX:【DevWidget-vn】'
// DevEnvironment - Android 环境配置切换库
implementation 'io.github.afkt:DevEnvironment:{12}'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:{13}' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:{14}' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:{15}' // kapt
implementation 'io.github.afkt:DevEnvironment:【DevEnvironment-vn】'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:【DevEnvironment-vn】' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:【DevEnvironment-vn】' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:【DevEnvironment-vn】' // kapt
// DevJava - Java 工具类库 ( 不依赖 android api )
implementation 'io.github.afkt:DevJava:{16}' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
implementation 'io.github.afkt:DevJava:【DevJava-vn】' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
```

## 赞赏
Expand Down
Loading

0 comments on commit be67d06

Please sign in to comment.