Skip to content

Commit

Permalink
docs: 更新部分版本信息、忽略配置
Browse files Browse the repository at this point in the history
  • Loading branch information
@afkT
afkT committed Sep 15, 2022
1 parent 934d86b commit 66ca187
Show file tree
Hide file tree
Showing 5 changed files with 309 additions and 123 deletions.
198 changes: 99 additions & 99 deletions src/main/java/javadoc/dev_utils/ApiConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,21 +204,6 @@ private ApiConfig() {
// DevRetrofit Template Readme
public static final String DEV_RETROFIT_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DevRetrofit_README.md";

// ============
// = DevOther =
// ============

// 包目录名
public static final String DEV_OTHER_PACKAGE = "";
// DevOther 文件路径
public static final String DEV_OTHER_PATH = PROJECT_LOCAL_PATH + "/DevUtils-repo/lib/LocalModules/DevOther/src/main/java/";
// DevOther GitHub 项目文件路径
public static final String DEV_OTHER_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils-repo/blob/main/lib/LocalModules/DevOther/src/main/java/";
// DevOther API 文件保存路径
public static final String DEV_OTHER_API_FILE_SAVE_PATH = API_LIB_FILE_SAVE_PATH + "/LocalModules/DevOther/";
// DevOther Template Readme
public static final String DEV_OTHER_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DevOther_README.md";

// =============
// = DevWidget =
// =============
Expand Down Expand Up @@ -264,6 +249,21 @@ private ApiConfig() {
// DevJava Template Readme
public static final String DEV_JAVA_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DevJava_README.md";

// ============
// = DevOther =
// ============

// 包目录名
public static final String DEV_OTHER_PACKAGE = "";
// DevOther 文件路径
public static final String DEV_OTHER_PATH = PROJECT_LOCAL_PATH + "/DevUtils-repo/lib/LocalModules/DevOther/src/main/java/";
// DevOther GitHub 项目文件路径
public static final String DEV_OTHER_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils-repo/blob/main/lib/LocalModules/DevOther/src/main/java/";
// DevOther API 文件保存路径
public static final String DEV_OTHER_API_FILE_SAVE_PATH = API_LIB_FILE_SAVE_PATH + "/LocalModules/DevOther/";
// DevOther Template Readme
public static final String DEV_OTHER_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DevOther_README.md";

// ===============
// = DevStandard =
// ===============
Expand Down Expand Up @@ -354,17 +354,6 @@ private ApiConfig() {
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Retrofit = new HashMap<>();

// ============
// = DevOther =
// ============

// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Other = new HashMap<>();
// 忽略不保存的类
public static final HashSet<String> sFilterClassSet_Other = new HashSet<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Other = new HashMap<>();

// =============
// = DevWidget =
// =============
Expand All @@ -376,6 +365,17 @@ private ApiConfig() {
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Widget = new HashMap<>();

// ============
// = DevOther =
// ============

// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Other = new HashMap<>();
// 忽略不保存的类
public static final HashSet<String> sFilterClassSet_Other = new HashSet<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Other = new HashMap<>();

static {
// 初始化 包名目录注释 Map
initCatalogMap();
Expand Down Expand Up @@ -495,6 +495,62 @@ private static void initCatalogMap() {
sCatalogMap_Assist.put(".engine.storage.listener", "Storage 存储结果事件");
sCatalogMap_Assist.put(".function", "快捷方法执行相关");

// ===========
// = DevBase =
// ===========

sCatalogMap_Base.put("dev.base", "根目录");
sCatalogMap_Base.put(".able", "基类库接口相关");
sCatalogMap_Base.put(".activity", "核心 Base Activity 代码");
sCatalogMap_Base.put(".adapter", "RecyclerView ViewBinding ViewHolder");
sCatalogMap_Base.put(".expand", "基于 Base Activity、Fragment 扩展包");
sCatalogMap_Base.put(".expand.content", "Content Layout 基类");
sCatalogMap_Base.put(".expand.mvp", "MVP 架构基类");
sCatalogMap_Base.put(".expand.viewbinding", "ViewBinding 基类");
sCatalogMap_Base.put(".fragment", "核心 Base Fragment 代码");
sCatalogMap_Base.put(".utils", "依赖工具包");
sCatalogMap_Base.put(".utils.assist", "功能辅助类 ( 抽取通用代码 )");

// ===============
// = DevBaseMVVM =
// ===============

sCatalogMap_BaseMVVM.put("dev.base", "根目录");
sCatalogMap_BaseMVVM.put(".able", "基类库接口相关");
sCatalogMap_BaseMVVM.put(".adapter", "RecyclerView ViewDataBinding ViewHolder");
sCatalogMap_BaseMVVM.put(".expand", "基于 Base Activity、Fragment 扩展包");
sCatalogMap_BaseMVVM.put(".expand.content", "Content Layout MVVM 基类");
sCatalogMap_BaseMVVM.put(".expand.mvvm", "MVVM 架构基类");
sCatalogMap_BaseMVVM.put(".expand.viewdata", "ViewDataBinding 基类");
sCatalogMap_BaseMVVM.put(".expand.viewmodel", "ViewModel 基类");
sCatalogMap_BaseMVVM.put(".utils", "依赖工具包");
sCatalogMap_BaseMVVM.put(".utils.assist", "功能辅助类 ( 抽取通用代码 )");

// =============
// = DevEngine =
// =============

sCatalogMap_Engine.put("dev.engine", "根目录");
sCatalogMap_Engine.put(".analytics", "Analytics Engine 数据统计 ( 埋点 )");
sCatalogMap_Engine.put(".barcode", "BarCode Engine 条形码、二维码处理");
sCatalogMap_Engine.put(".barcode.listener", "条形码、二维码操作回调事件");
sCatalogMap_Engine.put(".cache", "Cache Engine 有效期键值对缓存");
sCatalogMap_Engine.put(".compress", "Image Compress Engine 图片压缩");
sCatalogMap_Engine.put(".compress.listener", "图片压缩回调事件");
sCatalogMap_Engine.put(".http", "Http Engine 网络请求");
sCatalogMap_Engine.put(".image", "Image Engine 图片加载、下载、转格式等");
sCatalogMap_Engine.put(".image.listener", "图片加载监听事件");
sCatalogMap_Engine.put(".json", "JSON Engine 映射");
sCatalogMap_Engine.put(".keyvalue", "KeyValue Engine 键值对存储");
sCatalogMap_Engine.put(".log", "Log Engine 日志打印");
sCatalogMap_Engine.put(".media", "Media Selector Engine 多媒体资源选择");
sCatalogMap_Engine.put(".permission", "Permission Engine 权限申请");
sCatalogMap_Engine.put(".push", "Push Engine 推送平台处理");
sCatalogMap_Engine.put(".share", "Share Engine 分享平台处理");
sCatalogMap_Engine.put(".share.listener", "分享回调事件");
sCatalogMap_Engine.put(".storage", "Storage Engine 外部、内部文件存储");
sCatalogMap_Engine.put(".storage.listener", "Storage 存储结果事件");

// ==================
// = DevHttpCapture =
// ==================
Expand Down Expand Up @@ -524,6 +580,23 @@ private static void initCatalogMap() {
sCatalogMap_Retrofit.put(".http", "基于 OkHttp 管理实现代码");
sCatalogMap_Retrofit.put(".http.manager", "Retrofit 多 BaseUrl 管理");

// =============
// = DevWidget =
// =============

sCatalogMap_Widget.put("dev", "根目录");
sCatalogMap_Widget.put(".widget", "自定义 View 根目录");
sCatalogMap_Widget.put(".widget.adjust", "自动调节高度 View");
sCatalogMap_Widget.put(".widget.assist", "View 辅助类");
sCatalogMap_Widget.put(".widget.custom", "自定义 View");
sCatalogMap_Widget.put(".widget.decoration", "RecyclerView ItemDecoration");
sCatalogMap_Widget.put(".widget.decoration.grid", "Grid ItemDecoration");
sCatalogMap_Widget.put(".widget.decoration.linear", "Linear ItemDecoration");
sCatalogMap_Widget.put(".widget.function", "需求功能 View");
sCatalogMap_Widget.put(".widget.ui", "UI View");
sCatalogMap_Widget.put(".widget.ui.round", "圆角相关 View");
sCatalogMap_Widget.put(".widget.utils", "工具类目录");

// ============
// = DevOther =
// ============
Expand Down Expand Up @@ -578,79 +651,6 @@ private static void initCatalogMap() {
sCatalogMap_Other.put(".ktx.dev.other.retrofit_rxjava.demo", "Retrofit RxJava Demo");
sCatalogMap_Other.put(".ktx.dev.other.retrofit_rxjava.response", "请求响应解析");
sCatalogMap_Other.put(".ktx.dev.other.retrofit_rxjava.subscriber", "请求响应处理");

// =============
// = DevWidget =
// =============

sCatalogMap_Widget.put("dev", "根目录");
sCatalogMap_Widget.put(".widget", "自定义 View 根目录");
sCatalogMap_Widget.put(".widget.adjust", "自动调节高度 View");
sCatalogMap_Widget.put(".widget.assist", "View 辅助类");
sCatalogMap_Widget.put(".widget.custom", "自定义 View");
sCatalogMap_Widget.put(".widget.decoration", "RecyclerView ItemDecoration");
sCatalogMap_Widget.put(".widget.decoration.grid", "Grid ItemDecoration");
sCatalogMap_Widget.put(".widget.decoration.linear", "Linear ItemDecoration");
sCatalogMap_Widget.put(".widget.function", "需求功能 View");
sCatalogMap_Widget.put(".widget.ui", "UI View");
sCatalogMap_Widget.put(".widget.ui.round", "圆角相关 View");
sCatalogMap_Widget.put(".widget.utils", "工具类目录");

// ===========
// = DevBase =
// ===========

sCatalogMap_Base.put("dev.base", "根目录");
sCatalogMap_Base.put(".able", "基类库接口相关");
sCatalogMap_Base.put(".activity", "核心 Base Activity 代码");
sCatalogMap_Base.put(".adapter", "RecyclerView ViewBinding ViewHolder");
sCatalogMap_Base.put(".expand", "基于 Base Activity、Fragment 扩展包");
sCatalogMap_Base.put(".expand.content", "Content Layout 基类");
sCatalogMap_Base.put(".expand.mvp", "MVP 架构基类");
sCatalogMap_Base.put(".expand.viewbinding", "ViewBinding 基类");
sCatalogMap_Base.put(".fragment", "核心 Base Fragment 代码");
sCatalogMap_Base.put(".utils", "依赖工具包");
sCatalogMap_Base.put(".utils.assist", "功能辅助类 ( 抽取通用代码 )");

// ===============
// = DevBaseMVVM =
// ===============

sCatalogMap_BaseMVVM.put("dev.base", "根目录");
sCatalogMap_BaseMVVM.put(".able", "基类库接口相关");
sCatalogMap_BaseMVVM.put(".adapter", "RecyclerView ViewDataBinding ViewHolder");
sCatalogMap_BaseMVVM.put(".expand", "基于 Base Activity、Fragment 扩展包");
sCatalogMap_BaseMVVM.put(".expand.content", "Content Layout MVVM 基类");
sCatalogMap_BaseMVVM.put(".expand.mvvm", "MVVM 架构基类");
sCatalogMap_BaseMVVM.put(".expand.viewdata", "ViewDataBinding 基类");
sCatalogMap_BaseMVVM.put(".expand.viewmodel", "ViewModel 基类");
sCatalogMap_BaseMVVM.put(".utils", "依赖工具包");
sCatalogMap_BaseMVVM.put(".utils.assist", "功能辅助类 ( 抽取通用代码 )");

// =============
// = DevEngine =
// =============

sCatalogMap_Engine.put("dev.engine", "根目录");
sCatalogMap_Engine.put(".analytics", "Analytics Engine 数据统计 ( 埋点 )");
sCatalogMap_Engine.put(".barcode", "BarCode Engine 条形码、二维码处理");
sCatalogMap_Engine.put(".barcode.listener", "条形码、二维码操作回调事件");
sCatalogMap_Engine.put(".cache", "Cache Engine 有效期键值对缓存");
sCatalogMap_Engine.put(".compress", "Image Compress Engine 图片压缩");
sCatalogMap_Engine.put(".compress.listener", "图片压缩回调事件");
sCatalogMap_Engine.put(".http", "Http Engine 网络请求");
sCatalogMap_Engine.put(".image", "Image Engine 图片加载、下载、转格式等");
sCatalogMap_Engine.put(".image.listener", "图片加载监听事件");
sCatalogMap_Engine.put(".json", "JSON Engine 映射");
sCatalogMap_Engine.put(".keyvalue", "KeyValue Engine 键值对存储");
sCatalogMap_Engine.put(".log", "Log Engine 日志打印");
sCatalogMap_Engine.put(".media", "Media Selector Engine 多媒体资源选择");
sCatalogMap_Engine.put(".permission", "Permission Engine 权限申请");
sCatalogMap_Engine.put(".push", "Push Engine 推送平台处理");
sCatalogMap_Engine.put(".share", "Share Engine 分享平台处理");
sCatalogMap_Engine.put(".share.listener", "分享回调事件");
sCatalogMap_Engine.put(".storage", "Storage Engine 外部、内部文件存储");
sCatalogMap_Engine.put(".storage.listener", "Storage 存储结果事件");
}

/**
Expand Down

0 comments on commit 66ca187

Please sign in to comment.