Skip to content

Commit 7b036e9

Browse files
Updating mobile APIs
1 parent de60897 commit 7b036e9

File tree

18 files changed

+327
-164
lines changed

18 files changed

+327
-164
lines changed

_includes/sidelist-programming/programming-android.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<li><a href="{{ site.dcp_android_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
99
<li><a href="{{ site.dcv_android_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
1010
<li><a href="{{ site.dcp_android_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
11+
<li><a href="{{ site.dcp_android_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
1112
</ul>
1213
</li>
1314
<li><a class="otherLinkColour">Enumerations</a>

_includes/sidelist-programming/programming-ios.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<li><a href="{{ site.dcp_ios_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
99
<li><a href="{{ site.dcv_ios_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
1010
<li><a href="{{ site.dcp_ios_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
11+
<li><a href="{{ site.dcp_ios_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
1112
</ul>
1213
</li>
1314
<li><a class="otherLinkColour">Enumerations</a>

programming/android/api-reference/code-parser-module.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ needAutoGenerateSidebar: true
1010

1111
`CodeParserModule` class defines general functions of the code parser module.
1212

13+
## Definition
14+
15+
*Namespace:* com.dynamsoft.dcp
16+
17+
*Assembly:* DynamsoftCodeParser.aar
18+
19+
```java
20+
class CodeParserModule
21+
```
22+
1323
| Method | Description |
1424
|----------------------|-------------|
1525
| [`getVersion`](#getversion) | Get version information of SDK.|

programming/android/api-reference/code-parser.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ needAutoGenerateSidebar: true
88

99
# CodeParser Class
1010

11+
The `CodeParser` class enable users to configure the code parser settings or parse the content.
12+
13+
## Definition
14+
15+
*Namespace:* com.dynamsoft.dcp
16+
17+
*Assembly:* DynamsoftCodeParser.aar
18+
1119
```java
1220
class CodeParser
1321
```

programming/android/api-reference/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ needGenerateH3Content: true
1111

1212
## Classes
1313

14-
* [`CodeParser`](code-parser.md)
14+
* [`CodeParser`](code-parser.html)
1515
* [`LicenseManager`]({{ site.dcv_cpp_api }}license/license-manager.html)
16-
* [`ParsedResultItem`](parsed-result-item.md)
16+
* [`ParsedResultItem`](parsed-result-item.html)
17+
* [`ParsedResult`](parsed-result.html)
1718

1819
## Enumerations
1920

20-
* [`ErrorCode`]({{ site.enumerations }}core/error-code.html?lang=cpp)
21-
* [`MappingStatus`]({{ site.enumerations }}code-parser/mapping-status.html?lang=cpp)
22-
* [`ValidationStatus`]({{ site.enumerations }}code-parser/validation-status.html?lang=cpp)
21+
* [`ErrorCode`]({{ site.enumerations }}core/error-code.html?lang=android)
22+
* [`MappingStatus`]({{ site.enumerations }}code-parser/mapping-status.html?lang=android)
23+
* [`ValidationStatus`]({{ site.enumerations }}code-parser/validation-status.html?lang=android)

programming/android/api-reference/parsed-result-item.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ needAutoGenerateSidebar: true
88

99
# ParsedResultItem Class
1010

11+
`ParsedResultItem` it the basic unit of a parsed result. It stores the field name, value and additional information.
12+
13+
## Definition
14+
15+
*Namespace:* com.dynamsoft.dcp
16+
17+
*Assembly:* DynamsoftCodeParser.aar
18+
1119
```java
1220
class ParsedResultItem extends CapturedResultItem
1321
```

programming/android/api-reference/parsed-result.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ needAutoGenerateSidebar: true
99

1010
# ParsedResult Class
1111

12+
`ParsedResult` class stores all parsed result items that are obtained from a single image. It carries additional information such as the original image data or error messages.
13+
14+
## Definition
15+
16+
*Namespace:* com.dynamsoft.dcp
17+
18+
*Assembly:* DynamsoftCodeParser.aar
19+
1220
```java
1321
class ParsedResult
1422
```

programming/android/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ needGenerateH3Content: true
1919

2020
## Release Notes
2121

22-
- [Version 2.x](release-notes/cpp-2.md)
22+
- [Version 2.x](release-notes/android-2.md)

programming/android/release-notes/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,4 @@ needAutoGenerateSidebar: false
88

99
# Release Notes - Android Edition
1010

11-
- [2.0.20 (10/26/2023)](cpp-2.md#2020-10262023)
12-
- [2.0.10 (08/08/2023)](cpp-2.md#2010-08082023)
13-
- [2.0.0 (07/04/2023)](cpp-2.md#200-07042023)
11+
- [2.0.20 (11/30/2023)](android-2.md#2020-11302023)

programming/ios/api-reference/code-parser-module.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: default-layout
3-
title: CodeParserModule Class - Dynamsoft Code Parser SDK Android Edition API Reference
4-
description: This page shows CodeParserModule Class of Dynamsoft Code Parser SDK Android Edition.
5-
keywords: CodeParserModule, api reference, Android
3+
title: CodeParserModule Class - Dynamsoft Code Parser SDK iOS Edition API Reference
4+
description: This page shows CodeParserModule Class of Dynamsoft Code Parser SDK iOS Edition.
5+
keywords: CodeParserModule, api reference, iOS
66
needAutoGenerateSidebar: true
77
---
88

@@ -12,7 +12,7 @@ needAutoGenerateSidebar: true
1212

1313
## Definition
1414

15-
*Assembly:* DynamsoftCodeParser.framework
15+
*Assembly:* DynamsoftCodeParser.xcframework
1616

1717
<div class="sample-code-prefix"></div>
1818
>- Objective-C
@@ -27,6 +27,8 @@ needAutoGenerateSidebar: true
2727
class CodeParserModule : NSObject
2828
```
2929

30+
## Method Summary
31+
3032
| Method | Description |
3133
| ------ | ----------- |
3234
| [`getVersion`](#getversion) | Get version information of SDK.|
@@ -35,10 +37,6 @@ class CodeParserModule : NSObject
3537

3638
Get version information of SDK.
3739

38-
```java
39-
static String getVersion();
40-
```
41-
4240
<div class="sample-code-prefix"></div>
4341
>- Objective-C
4442
>- Swift

0 commit comments

Comments
 (0)