Skip to content

Commit

Permalink
1.更新 API 文档
Browse files Browse the repository at this point in the history
Former-commit-id: fde09b4
  • Loading branch information
afkT committed Sep 19, 2021
1 parent 25f57a6 commit 05511a3
Show file tree
Hide file tree
Showing 24 changed files with 76 additions and 76 deletions.
4 changes: 2 additions & 2 deletions app/src/main/java/utils_use/snackbar/SnackbarUse.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ public void snackbarUse() {
// 获取 Snackbar 底层 View
View snackbarView = SnackbarUtils.with(view).getSnackbarView();

// 获取 Snackbar TextView(snackbar_text) - 左侧 文本 TextView
// 获取 Snackbar TextView ( snackbar_text ) - 左侧 文本 TextView
TextView textView = SnackbarUtils.with(view).getTextView();

// 获取 Snackbar Action Button(snackbar_action) - 右侧 Button
// 获取 Snackbar Action Button ( snackbar_action ) - 右侧 Button
Button actionButton = SnackbarUtils.with(view).getActionButton();

// =
Expand Down
48 changes: 24 additions & 24 deletions lib/DevApp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1024,7 +1024,7 @@ DevUtils.openDebug();
| setMobileDataEnabled | 设置移动网络开关 ( 无判断是否已开启移动网络 ) |
| isConnect | 判断是否连接了网络 |
| getConnectType | 获取连接的网络类型 |
| isConnWifi | 判断是否连接 Wifi( 连接上、连接中 ) |
| isConnWifi | 判断是否连接 Wifi ( 连接上、连接中 ) |
| isConnMobileData | 判断是否连接移动网络 ( 连接上、连接中 ) |
| isAvailable | 判断网络是否可用 |
| isAvailableByPing | 使用 ping ip 方式判断网络是否可用 |
Expand Down Expand Up @@ -1558,7 +1558,7 @@ DevUtils.openDebug();
| isSuccess | 判断是否执行成功 |
| isSuccess2 | 判断是否执行成功 ( 判断 errorMsg ) |
| isSuccess3 | 判断是否执行成功 ( 判断 successMsg ) |
| isSuccess4 | 判断是否执行成功 ( 判断 successMsg ), 并且 successMsg 是否包含某个字符串 |
| isSuccess4 | 判断是否执行成功 ( 判断 successMsg ) , 并且 successMsg 是否包含某个字符串 |


* **快捷方式工具类 ->** [ShortCutUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/ShortCutUtils.java)
Expand Down Expand Up @@ -1591,13 +1591,13 @@ DevUtils.openDebug();
| 方法 | 注释 |
| :- | :- |
| dipConvertPx | dp 转 px |
| dipConvertPxf | dp 转 px (float) |
| dipConvertPxf | dp 转 px ( float ) |
| pxConvertDip | px 转 dp |
| pxConvertDipf | px 转 dp (float) |
| pxConvertDipf | px 转 dp ( float ) |
| spConvertPx | sp 转 px |
| spConvertPxf | sp 转 px (float) |
| spConvertPxf | sp 转 px ( float ) |
| pxConvertSp | px 转 sp |
| pxConvertSpf | px 转 sp (float) |
| pxConvertSpf | px 转 sp ( float ) |
| applyDimension | 各种单位转换 ( 该方法存在于 TypedValue.applyDimension ) |
| forceGetViewSize | 在 onCreate 中获取视图的尺寸 ( 需回调 onGetSizeListener 接口, 在 onGetSize 中获取 View 宽高 ) |
| measureView | 测量 View |
Expand All @@ -1614,10 +1614,10 @@ DevUtils.openDebug();
| setStyle | 设置样式 |
| getSnackbar | 获取 Snackbar |
| getSnackbarView | 获取 Snackbar View |
| getTextView | 获取 Snackbar TextView(snackbar_text) |
| getActionButton | 获取 Snackbar Action Button(snackbar_action) |
| getTextView | 获取 Snackbar TextView ( snackbar_text ) |
| getActionButton | 获取 Snackbar Action Button ( snackbar_action ) |
| getSnackbarLayout | 获取 Snackbar.SnackbarLayout ( FrameLayout ) |
| getSnackbarContentLayout | 获取 SnackbarContentLayout ( LinearLayout ( messageView、actionView ) ) |
| getSnackbarContentLayout | 获取 SnackbarContentLayout ( LinearLayout ( messageView、actionView ) ) |
| addView | 向 Snackbar 布局中添加 View ( Google 不建议, 复杂的布局应该使用 DialogFragment 进行展示 ) |
| setCallback | 设置 Snackbar 展示完成、隐藏完成 的监听 |
| setAction | 设置 Action 按钮文字内容及点击监听 |
Expand Down Expand Up @@ -1723,7 +1723,7 @@ DevUtils.openDebug();
| getLineSpacingExtra | 获取文字行间距 ( 行高 ) |
| getLineSpacingMultiplier | 获取文字行间距倍数 |
| setLineSpacing | 设置文字行间距 ( 行高 ) |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 )、行间距倍数 |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 ) 、行间距倍数 |
| getTextScaleX | 获取字体水平方向的缩放 |
| setTextScaleX | 设置字体水平方向的缩放 |
| getIncludeFontPadding | 是否保留字体留白间隙区域 |
Expand Down Expand Up @@ -1827,8 +1827,8 @@ DevUtils.openDebug();
| isQ | 是否在 10.0 版本及以上 |
| isR | 是否在 11.0 版本及以上 |
| isS | 是否在 12.0 版本及以上 |
| convertSDKVersion | 转换 SDK 版本 convertSDKVersion(31) = Android 12.0 |
| convertSDKVersionName | 转换 SDK 版本名字 convertSDKVersionName(31) = Android S |
| convertSDKVersion | 转换 SDK 版本 convertSDKVersion ( 31 ) = Android 12.0 |
| convertSDKVersionName | 转换 SDK 版本名字 convertSDKVersionName ( 31 ) = Android S |


* **震动相关工具类 ->** [VibrationUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/VibrationUtils.java)
Expand Down Expand Up @@ -2563,7 +2563,7 @@ DevUtils.openDebug();
| setStrikeThruText | 设置中划线 |
| setLetterSpacing | 设置文字水平间距 |
| setLineSpacing | 设置文字行间距 ( 行高 ) |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 )、行间距倍数 |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 ) 、行间距倍数 |
| setTextScaleX | 设置字体水平方向的缩放 |
| setIncludeFontPadding | 设置是否保留字体留白间隙区域 |
| setLines | 设置行数 |
Expand Down Expand Up @@ -2777,7 +2777,7 @@ DevUtils.openDebug();
| setStrikeThruText | 设置中划线 |
| setLetterSpacing | 设置文字水平间距 |
| setLineSpacing | 设置文字行间距 ( 行高 ) |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 )、行间距倍数 |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 ) 、行间距倍数 |
| setTextScaleX | 设置字体水平方向的缩放 |
| setIncludeFontPadding | 设置是否保留字体留白间隙区域 |
| setLines | 设置行数 |
Expand Down Expand Up @@ -3060,7 +3060,7 @@ DevUtils.openDebug();
| setStrikeThruText | 设置中划线 |
| setLetterSpacing | 设置文字水平间距 |
| setLineSpacing | 设置文字行间距 ( 行高 ) |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 )、行间距倍数 |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 ) 、行间距倍数 |
| setTextScaleX | 设置字体水平方向的缩放 |
| setIncludeFontPadding | 设置是否保留字体留白间隙区域 |
| setLines | 设置行数 |
Expand Down Expand Up @@ -3267,7 +3267,7 @@ DevUtils.openDebug();
| setStrikeThruText | 设置中划线 |
| setLetterSpacing | 设置文字水平间距 |
| setLineSpacing | 设置文字行间距 ( 行高 ) |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 )、行间距倍数 |
| setLineSpacingAndMultiplier | 设置文字行间距 ( 行高 ) 、行间距倍数 |
| setTextScaleX | 设置字体水平方向的缩放 |
| setIncludeFontPadding | 设置是否保留字体留白间隙区域 |
| setLines | 设置行数 |
Expand Down Expand Up @@ -3595,9 +3595,9 @@ DevUtils.openDebug();
| getAppPermission | 获取 APP 注册的权限 |
| permission | 申请权限初始化 |
| callback | 设置回调方法 |
| setRequestPermissionsResult | 设置是否需要在 Activity 的 onRequestPermissionsResult 回调中, 调用 PermissionUtils.onRequestPermissionsResult(this); |
| setRequestPermissionsResult | 设置是否需要在 Activity 的 onRequestPermissionsResult 回调中, 调用 PermissionUtils.onRequestPermissionsResult ( this ) ; |
| request | 请求权限 |
| onRequestPermissionsResult | 请求权限回调 ( 需要在 Activity 的 onRequestPermissionsResult 回调中, 调用 PermissionUtils.onRequestPermissionsResult(this); ) |
| onRequestPermissionsResult | 请求权限回调 ( 需要在 Activity 的 onRequestPermissionsResult 回调中, 调用 PermissionUtils.onRequestPermissionsResult ( this ) ; ) |
| notifyPermissionsChange | 刷新权限改变处理 ( 清空已拒绝的权限记录 ) |
| againRequest | 再次请求处理操作 |

Expand Down Expand Up @@ -4649,7 +4649,7 @@ DevUtils.openDebug();
| isInstance | 是不是某个类的实例 |
| getArgsClass | 获取参数类型 |
| getPropertyByParent | 获取父类中的变量对象 |
| getDeclaredFieldParent | 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField) |
| getDeclaredFieldParent | 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField ) |


* **反射相关工具类 ->** [ReflectUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/ReflectUtils.java)
Expand All @@ -4674,7 +4674,7 @@ DevUtils.openDebug();
| 方法 | 注释 |
| :- | :- |
| calcScale | 计算比例 ( 商 ) |
| calcScaleToMath | 计算比例 ( 被除数 ( 最大值 ) / 除数 ( 最小值 ) ) |
| calcScaleToMath | 计算比例 ( 被除数 ( 最大值 ) / 除数 ( 最小值 ) ) |
| calcScaleToWidth | 计算缩放比例 ( 根据宽度比例转换高度 ) |
| calcScaleToHeight | 计算缩放比例 ( 根据高度比例转换宽度 ) |
| calcWidthHeightToScale | 通过宽度、高度根据对应的比例, 转换成对应的比例宽度高度 ( 智能转换 ) |
Expand Down Expand Up @@ -4789,7 +4789,7 @@ DevUtils.openDebug();
| sqliteEscape | 字符串数据库字符转义 |
| convertHideMobile | 转换手机号 |
| convertSymbolHide | 转换符号处理 |
| subEllipsize | 裁剪超出的内容, 并且追加符号 ( 如 ...) |
| subEllipsize | 裁剪超出的内容, 并且追加符号 ( 如 ... ) |
| subSymbolHide | 裁剪符号处理 |
| subSetSymbol | 裁剪内容 ( 设置符号处理 ) |
| substring | 裁剪字符串 |
Expand Down Expand Up @@ -5092,8 +5092,8 @@ DevUtils.openDebug();

| 方法 | 注释 |
| :- | :- |
| md5 | 加密内容 (32 位小写 MD5) |
| md5Upper | 加密内容 (32 位大写 MD5) |
| md5 | 加密内容 ( 32 位小写 MD5 ) |
| md5Upper | 加密内容 ( 32 位大写 MD5 ) |
| getFileMD5 | 获取文件 MD5 值 |
| getFileMD5ToHexString | 获取文件 MD5 值 |

Expand Down Expand Up @@ -5208,7 +5208,7 @@ DevUtils.openDebug();
| getCalcThreads | 获取线程数 |
| execute | 加入到线程池任务队列 |
| shutdown | shutdown 会等待所有提交的任务执行完成, 不管是正在执行还是保存在任务队列中的已提交任务 |
| shutdownNow | shutdownNow 会尝试中断正在执行的任务 ( 其主要是中断一些指定方法如 sleep 方法 ), 并且停止执行等待队列中提交的任务 |
| shutdownNow | shutdownNow 会尝试中断正在执行的任务 ( 其主要是中断一些指定方法如 sleep 方法 ) , 并且停止执行等待队列中提交的任务 |
| isShutdown | 判断线程池是否已关闭 ( isShutDown 当调用 shutdown() 方法后返回为 true ) |
| isTerminated | 若关闭后所有任务都已完成, 则返回 true |
| awaitTermination | 请求关闭、发生超时或者当前线程中断 |
Expand Down
2 changes: 1 addition & 1 deletion lib/DevApp/src/main/java/dev/utils/app/NetWorkUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ public static int getConnectType() {
}

/**
* 判断是否连接 Wifi( 连接上、连接中 )
* 判断是否连接 Wifi ( 连接上、连接中 )
* @return {@code true} yes, {@code false} no
*/
@RequiresPermission(Manifest.permission.ACCESS_NETWORK_STATE)
Expand Down
2 changes: 1 addition & 1 deletion lib/DevApp/src/main/java/dev/utils/app/ShellUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ public boolean isSuccess3() {
}

/**
* 判断是否执行成功 ( 判断 successMsg ), 并且 successMsg 是否包含某个字符串
* 判断是否执行成功 ( 判断 successMsg ) , 并且 successMsg 是否包含某个字符串
* @param contains 待校验包含字符串
* @return {@code true} yes, {@code false} no
*/
Expand Down
16 changes: 8 additions & 8 deletions lib/DevApp/src/main/java/dev/utils/app/SizeUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static int dipConvertPx(final float dpValue) {
}

/**
* dp 转 px (float)
* dp 转 px ( float )
* @param dpValue 待转换值
* @return 转换后的值
*/
Expand All @@ -46,7 +46,7 @@ public static int pxConvertDip(final float pxValue) {
}

/**
* px 转 dp (float)
* px 转 dp ( float )
* @param pxValue 待转换值
* @return 转换后的值
*/
Expand All @@ -64,7 +64,7 @@ public static int spConvertPx(final float spValue) {
}

/**
* sp 转 px (float)
* sp 转 px ( float )
* @param spValue 待转换值
* @return 转换后的值
*/
Expand All @@ -82,7 +82,7 @@ public static int pxConvertSp(final float pxValue) {
}

/**
* px 转 sp (float)
* px 转 sp ( float )
* @param pxValue 待转换值
* @return 转换后的值
*/
Expand All @@ -108,7 +108,7 @@ public static int dipConvertPx(
}

/**
* dp 转 px (float)
* dp 转 px ( float )
* @param dpValue 待转换值
* @param metrics {@link DisplayMetrics}
* @return 转换后的值
Expand All @@ -134,7 +134,7 @@ public static int pxConvertDip(
}

/**
* px 转 dp (float)
* px 转 dp ( float )
* @param pxValue 待转换值
* @param metrics {@link DisplayMetrics}
* @return 转换后的值
Expand Down Expand Up @@ -168,7 +168,7 @@ public static int spConvertPx(
}

/**
* sp 转 px (float)
* sp 转 px ( float )
* @param spValue 待转换值
* @param metrics {@link DisplayMetrics}
* @return 转换后的值
Expand All @@ -194,7 +194,7 @@ public static int pxConvertSp(
}

/**
* px 转 sp (float)
* px 转 sp ( float )
* @param pxValue 待转换值
* @param metrics {@link DisplayMetrics}
* @return 转换后的值
Expand Down
4 changes: 2 additions & 2 deletions lib/DevApp/src/main/java/dev/utils/app/SnackbarUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public View getSnackbarView() {
}

/**
* 获取 Snackbar TextView(snackbar_text)
* 获取 Snackbar TextView ( snackbar_text )
* @return Snackbar {@link TextView}
*/
public TextView getTextView() {
Expand All @@ -160,7 +160,7 @@ public TextView getTextView() {
}

/**
* 获取 Snackbar Action Button(snackbar_action)
* 获取 Snackbar Action Button ( snackbar_action )
* <pre>
* 右边按钮 ( 如: 撤销 )
* </pre>
Expand Down
4 changes: 2 additions & 2 deletions lib/DevApp/src/main/java/dev/utils/app/TextViewUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -1403,7 +1403,7 @@ public static <T extends TextView> T setLineSpacing(
}

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param textView {@link TextView}
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
Expand Down Expand Up @@ -1438,7 +1438,7 @@ public static View setLineSpacing(
}

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param view {@link TextView}
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1701,7 +1701,7 @@ T setBold(
T setLineSpacing(float lineSpacing);

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
* @return Helper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2730,7 +2730,7 @@ public QuickHelper setLineSpacing(float lineSpacing) {
}

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
* @return Helper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2382,7 +2382,7 @@ T setLineSpacing(
);

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
* @param views View[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3726,7 +3726,7 @@ public ViewHelper setLineSpacing(
}

/**
* 设置文字行间距 ( 行高 )、行间距倍数
* 设置文字行间距 ( 行高 ) 、行间距倍数
* @param lineSpacing 文字行间距 ( 行高 ), android:lineSpacingExtra
* @param multiplier 行间距倍数, android:lineSpacingMultiplier
* @param views View[]
Expand Down
4 changes: 2 additions & 2 deletions lib/DevApp/src/main/java/dev/utils/common/Reflect2Utils.java
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ public static <T> T getPropertyByParent(
}

/**
* 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField)
* 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField )
* @param object 对象
* @param fieldName 属性名
* @return {@link Field}
Expand All @@ -654,7 +654,7 @@ public static Field getDeclaredFieldParent(
}

/**
* 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField)
* 获取父类中的变量对象 ( 循环向上转型, 获取对象的 DeclaredField )
* @param object 子类对象
* @param fieldName 父类中的属性名
* @param fieldNumber 字段出现次数, 如果父类还有父类, 并且有相同变量名, 设置负数 一直会跟到最后的变量
Expand Down
2 changes: 1 addition & 1 deletion lib/DevApp/src/main/java/dev/utils/common/StringUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -1607,7 +1607,7 @@ public static String convertSymbolHide(
// =

/**
* 裁剪超出的内容, 并且追加符号 ( 如 ...)
* 裁剪超出的内容, 并且追加符号 ( 如 ... )
* @param maxLength 允许最大的长度
* @param str 待处理字符串
* @param symbol 转换符号
Expand Down
Loading

0 comments on commit 05511a3

Please sign in to comment.