Skip to content

Commit 3c59029

Browse files
committed
优化注释
1 parent 928c6ae commit 3c59029

File tree

5 files changed

+19
-8
lines changed

5 files changed

+19
-8
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,9 @@ implementation 'com.github.jenly1314.MLKit:mlkit-text-recognition:1.3.0'
229229

230230
> 你也可以自定义或覆写 **CameraConfig** 中的 **options** 方法,根据需要定制配置。
231231
232-
> 这里特别温馨提示:默认配置在未配置相机的目标分析图像大小时,会优先使用:横屏:640 * 480 竖屏:480 * 640;
232+
这里特别温馨提示:默认配置在未配置相机的目标分析图像大小时,会优先使用:横屏:640 * 480 竖屏:480 * 640;
233233

234-
#### 根据这个图像质量顺便说下默认配置的优缺点:
234+
根据这个图像质量顺便说下默认配置的优缺点:
235235

236236
* 优点:因为图像质量不高,所以在低配置的设备上使用也能hold住,这样就能尽可能的适应各种设备;
237237
* 缺点:正是由于图像质量不高,从而可能会对检测识别率略有影响,比如在某些机型上体验欠佳。
@@ -240,11 +240,22 @@ implementation 'com.github.jenly1314.MLKit:mlkit-text-recognition:1.3.0'
240240
> 当使用默认的 **CameraConfig** 在某些机型上体验欠佳时,你可以尝试使用 **AspectRatioCameraConfig**
241241
**ResolutionCameraConfig** 会有意想不到奇效。
242242

243+
### 关于 **Analyzer**
244+
245+
**Analyzer** 为定义的分析器接口;主要用于分析相机预览的帧数据;MLKit的各个子库皆是通过实现 **Analyzer** 来检测分析结果的。
246+
247+
### 关于 **BaseCameraScanActivity****BaseCameraScanFragment**
248+
249+
**BaseCameraScanActivity****BaseCameraScanFragment** 作为扫描预览界面的基类,主要目的是便于快速实现扫描识别。
250+
251+
> 扫描预览界面内部持有 **CameraScan**,并处理了 **CameraScan** 的初始化(如:相机权限、相机预览、生命周期等细节)
243252
244253
### 布局示例
245254

246-
**PreviewView** 用来预览,布局内至少要保证有 **PreviewView**;如果是继承 **BaseCameraScanActivity****BaseCameraScanFragment** 或其子类实现的相机扫描;快速实现扫描功能;
247-
需自定义布局时,覆写getLayoutId方法即可;预览控件ID可覆写getPreviewViewId方法自定义,更多代码用法可**BaseCameraScanActivity**源码或参见下面的使用示例。
255+
**PreviewView** 用来预览,布局内至少要保证有 **PreviewView**;如果是继承 **BaseCameraScanActivity**
256+
**BaseCameraScanFragment** 或其子类实现的相机扫描;快速实现扫描功能;
257+
258+
需自定义布局时,通过覆写getLayoutId方法即可;预览控件ID可覆写getPreviewViewId方法自定义;更多代码用法可**BaseCameraScanActivity**源码或参见下面的使用示例。
248259

249260
示例:
250261

mlkit-camera-core/src/main/java/com/king/mlkit/vision/camera/BaseCameraScan.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
* <p>
5757
* 快速实现扫描识别主要有以下几种方式:
5858
* <p>
59-
* 1、通过继承 {@linkBaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
59+
* 1、通过继承 {@link BaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
6060
* (适用于大多数场景,自定义布局时需覆写getLayoutId方法)
6161
* <p>
6262
* 2、在你项目的Activity或者Fragment中实例化一个{@link BaseCameraScan}。(适用于想在扫码界面写交互逻辑,又因为项目

mlkit-camera-core/src/main/java/com/king/mlkit/vision/camera/BaseCameraScanActivity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
* <p>
3333
* 快速实现扫描识别主要有以下几种方式:
3434
* <p>
35-
* 1、通过继承 {@linkBaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
35+
* 1、通过继承 {@link BaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
3636
* (适用于大多数场景,自定义布局时需覆写getLayoutId方法)
3737
* <p>
3838
* 2、在你项目的Activity或者Fragment中实例化一个{@link BaseCameraScan}。(适用于想在扫码界面写交互逻辑,又因为项目

mlkit-camera-core/src/main/java/com/king/mlkit/vision/camera/BaseCameraScanFragment.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* <p>
3636
* 快速实现扫描识别主要有以下几种方式:
3737
* <p>
38-
* 1、通过继承 {@linkBaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
38+
* 1、通过继承 {@link BaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
3939
* (适用于大多数场景,自定义布局时需覆写getLayoutId方法)
4040
* <p>
4141
* 2、在你项目的Activity或者Fragment中实例化一个{@link BaseCameraScan}。(适用于想在扫码界面写交互逻辑,又因为项目

mlkit-camera-core/src/main/java/com/king/mlkit/vision/camera/CameraScan.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* <p>
3131
* 快速实现扫描识别主要有以下几种方式:
3232
* <p>
33-
* 1、通过继承 {@linkBaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
33+
* 1、通过继承 {@link BaseCameraScanActivity}或者{@link BaseCameraScanFragment}或其子类,可快速实现扫描识别。
3434
* (适用于大多数场景,自定义布局时需覆写getLayoutId方法)
3535
* <p>
3636
* 2、在你项目的Activity或者Fragment中实例化一个{@link BaseCameraScan}。(适用于想在扫码界面写交互逻辑,又因为项目

0 commit comments

Comments
 (0)