Skip to content

[Doc Review] Missing docs for EnumMRZScanMode and EnumMRZScannerViews #53

@Tom-Dynamsoft

Description

@Tom-Dynamsoft

Documentation Issue: Missing documentation for EnumMRZScanMode and EnumMRZScannerViews

Category: Completeness
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: C1, C2

Problem

Two exported enums have no documentation:

  1. EnumMRZScanMode — 7 values: Passport, TD1, TD2, PassportAndTD1, PassportAndTD2, TD1AndTD2, All. Used by UtilizedTemplateNames and DEFAULT_TEMPLATE_NAMES.
  2. EnumMRZScannerViews — 2 values: Scanner = "scanner", Result = "scan-result".

Location

  • Should be in: api/enums-mrz-scanner.md
  • Source: dist/mrz-scanner.d.ts

Recommended Fix

Add sections for both enums in api/enums-mrz-scanner.md with their syntax blocks. Also update the API index (api/index.md) to list these enums.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationreview-findingFinding from automated documentation review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions