Skip to content

Commit 393fcc1

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #12 from dynamsoft-docs/preview
update to internal commit 7e586256
2 parents bcd3c6b + 1b13950 commit 393fcc1

File tree

15 files changed

+380
-1
lines changed

15 files changed

+380
-1
lines changed

‎_config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,13 @@ dcp_ios: /code-parser/docs/mobile/programming/ios/
1515
dcp_ios_api: /code-parser/docs/mobile/programming/ios/api-reference/
1616
dcp_ios_release_notes: /code-parser/docs/mobile/programming/ios/release-notes/
1717

18+
dcp_maui: /code-parser/docs/mobile/programming/maui/
19+
dcp_maui_api: /code-parser/docs/mobile/programming/maui/api-reference/
20+
dcp_maui_release_notes: /code-parser/docs/mobile/programming/maui/release-notes/
21+
1822
dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
1923
dcv_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
24+
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
2025
dcv_enumerations: /capture-vision/docs/core/enums/
2126
dcv_parameter_reference: /capture-vision/docs/core/parameters/reference/
2227
dcv_parameter: /capture-vision/docs/core/parameters/
@@ -64,6 +69,11 @@ defaults:
6469
values:
6570
docRootName: "Code Parser iOS Edition"
6671
docHomePage: "/code-parser/docs/mobile/programming/ios/"
72+
- scope:
73+
path: "programming/maui"
74+
values:
75+
docRootName: "Code Parser MAUI Edition"
76+
docHomePage: "/code-parser/docs/mobile/programming/maui/"
6777
- scope:
6878
path: "Hide_Tree_Page.html"
6979
values:

‎_data/full_tree.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ tree_file_list:
22
- sidelist-full-tree.html
33
- sidelist-programming/programming-android.html
44
- sidelist-programming/programming-ios.html
5+
- sidelist-programming/programming-maui.html

‎_data/product_version.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ version_info_list_mobile:
44
- value: latest version
55
- value: 2.x
66
child:
7+
- 2.2.11_android
8+
- 2.2.10
79
- 2.0.21_ios
810
- 2.0.20

‎_includes/sidelist-full-tree.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,7 @@
77
<a href="{{ site.dcp_ios }}" class="otherLinkColour">DCP-iOS Introduction</a>
88
</li>
99
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
10+
<li lang="maui">
11+
<a href="{{ site.dcp_maui }}" class="otherLinkColour">DCP-MAUI Introduction</a>
12+
</li>
13+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}

‎_includes/sidelist-programming/programming-maui.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<li lang="maui" class="category">DEVELOPMENT ON MAUI</li>
2+
<li lang="maui"><a class="otherLinkColour">API Reference</a>
3+
<ul>
4+
<li><a class="otherLinkColour">Classes</a>
5+
<ul>
6+
<li><a href="{{ site.dcp_maui_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
7+
<li><a href="{{ site.dcp_maui_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
8+
<li><a href="{{ site.dcp_maui_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
9+
</ul>
10+
</li>
11+
<li><a class="otherLinkColour">Enumerations</a>
12+
<ul>
13+
<li><a href="{{ site.dcp_maui_api }}enum/mapping-status.html" class="otherLinkColour">MappingStatus</a></li>
14+
<li><a href="{{ site.dcp_maui_api }}enum/validation-status.html" class="otherLinkColour">ValidationStatus</a></li>
15+
</ul>
16+
</li>
17+
</ul>
18+
</li>
19+
<li lang="maui" class="category">USEFUL RESOURCES</li>
20+
<li lang="maui"><a href="{{ site.dcp_maui }}release-notes/index.html" class="otherLinkColour">Release Notes</a>
21+
<ul >
22+
<li ><a href="{{ site.dcp_maui }}release-notes/maui-2.html" class="otherLinkColour">Version 2.x</a></li>
23+
</ul>
24+
</li>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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.
11+
`ParsedResultItem` is the basic unit of a parsed result. It stores the field name, value and additional information.
1212

1313
## Definition
1414

‎programming/maui/api-reference/code-parser-module.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default-layout
3+
title: CodeParserModule Class - DCP MAUI Edition API Reference
4+
description: This page shows CodeParserModule Class of Dynamsoft Code Parser SDK MAUI Edition.
5+
keywords: CodeParserModule, api reference, MAUI
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# CodeParserModule Class
10+
11+
`CodeParserModule` class defines general functions of the code parser module.
12+
13+
## Definition
14+
15+
*Namespace:* Dynamsoft.CodeParser.Maui
16+
17+
*Assembly:* Dynamsoft.CodeParser.Maui
18+
19+
```csharp
20+
class CodeParserModule
21+
```
22+
23+
## Methods
24+
25+
| Method | Description |
26+
|--------|-------------|
27+
| [`GetVersion`](#getversion) | Get version information of SDK.|
28+
29+
### GetVersion
30+
31+
Get version information of SDK.
32+
33+
```csharp
34+
static string GetVersion();
35+
```
36+
37+
**Return Value**
38+
39+
The version information string.

‎programming/maui/api-reference/enum/mapping-status.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: EnumMappingStatus - DCP MAUI Edition API Reference
4+
description: Enumeration EnumMappingStatus of
5+
keywords: Mapping status
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: EnumMappingStatus
9+
---
10+
11+
# EnumMappingStatus
12+
13+
`MappingStatus` represents the outcome of a mapping operation on a field.
14+
15+
## Definition
16+
17+
*Namespace:* Dynamsoft.CodeParser.Maui
18+
19+
*Assembly:* Dynamsoft.CodeParser.Maui
20+
21+
```csharp
22+
public enum EnumMappingStatus
23+
{
24+
/** The field has no mapping specified. */
25+
MS_NONE = 0,
26+
/** Find a mapping for the field value. */
27+
MS_SUCCEEDED = 1,
28+
/** Failed to find a mapping for the field value. */
29+
MS_FAILED = 2
30+
}
31+
```

‎programming/maui/api-reference/enum/validation-status.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: EnumValidationStatus - DCP MAUI Edition API Reference
4+
description: Enumeration EnumValidationStatus of
5+
keywords: validation status
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: EnumValidationStatus
9+
---
10+
11+
# EnumValidationStatus
12+
13+
`ValidationStatus` describes the outcome of a validation process on a field.
14+
15+
## Definition
16+
17+
*Namespace:* Dynamsoft.CodeParser.Maui
18+
19+
*Assembly:* Dynamsoft.CodeParser.Maui
20+
21+
```csharp
22+
public enum EnumValidationStatus
23+
{
24+
/** The field has no validation specified. */
25+
VS_NONE = 0,
26+
/** The validation for the field has been succeeded. */
27+
VS_SUCCEEDED = 1,
28+
/** The validation for the field has been failed. */
29+
VS_FAILED = 2
30+
}
31+
```

‎programming/maui/api-reference/parsed-field.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: default-layout
3+
title: ParsedField Class - DCP MAUI Edition API Reference
4+
description: ParsedField class defindes the parsed field with its name, value and addtitional information.
5+
keywords: ParsedField, api reference, Android
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# ParsedField Class
10+
11+
`ParsedField` class defindes the parsed field with its name, value and addtitional information.
12+
13+
## Definition
14+
15+
*Namespace:* Dynamsoft.CodeParser.Maui
16+
17+
*Assembly:* Dynamsoft.CodeParser.Maui
18+
19+
```csharp
20+
class ParsedField
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`Name`](#name) | *string* | The field name. |
28+
| [`Value`](#value) | *string* | The field value. |
29+
| [`MappingStatus`](#mappingstatus) | *EnumMappingStatus* | The mapping status of the field. |
30+
| [`ValidationStatus`](#validationstatus) | *EnumValidationStatus* | The validation status of the field. |
31+
32+
### Name
33+
34+
The field name.
35+
36+
```csharp
37+
string Name { get; }
38+
```
39+
40+
### Value
41+
42+
The field value.
43+
44+
```csharp
45+
string Value { get; }
46+
```
47+
48+
### MappingStatus
49+
50+
The mapping status of the field.
51+
52+
```csharp
53+
EnumMappingStatus MappingStatus { get; }
54+
```
55+
56+
### ValidationStatus
57+
58+
The validation status of the field.
59+
60+
```csharp
61+
EnumValidationStatus ValidationStatus { get; }
62+
```

0 commit comments

Comments
 (0)