Skip to content

[Doc Review] MRZScannerViewConfig missing cameraEnhancerUIPath and mrzFormatType #51

@Tom-Dynamsoft

Description

@Tom-Dynamsoft

Documentation Issue: MRZScannerViewConfig missing properties (cameraEnhancerUIPath, mrzFormatType)

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

Problem

Two properties from the MRZScannerViewConfig interface are present in the SDK source but missing from the docs:

  1. cameraEnhancerUIPath?: string — Still exists in source alongside uiPath. The customization guide mentions "uiPath (formerly cameraEnhancerUIPath)" but the property is not documented in the API reference.
  2. mrzFormatType?: EnumMRZDocumentType | Array<EnumMRZDocumentType> — Not listed in the syntax block or properties table at all.

Location

  • Docs file: api/mrz-scanner.md — MRZScannerViewConfig syntax block and properties table

Recommended Fix

  1. Document cameraEnhancerUIPath as a deprecated alias of uiPath, or add a note that it still exists for backward compatibility.
  2. Add mrzFormatType to the syntax block and properties table. Note the type difference from MRZScannerConfig (which only accepts Array<EnumMRZDocumentType>, while MRZScannerViewConfig also accepts a single value).

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