Skip to content

[Doc Review] Missing docs for MRZScannerView, MRZResultView, and initialize() #54

@Tom-Dynamsoft

Description

@Tom-Dynamsoft

Documentation Issue: Missing docs for MRZScannerView, MRZResultView classes and initialize() method

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

Problem

Three exported APIs lack documentation:

  1. MRZScannerView class — Exported with public methods: initialize(), openCamera(), closeCamera(), pauseCamera(), stopCapturing(), handleMRZResult(), launch(). The API index references it but provides no link.

  2. MRZResultView class — Exported with public methods: launch(), initialize(), hideView(), dispose(). The API index references it but provides no link.

  3. MRZScanner.initialize() method — Returns Promise<{resources: SharedResources, components: {scannerView?, resultView?}}>. Allows advanced users to access underlying resources and view components for custom workflows. Currently only launch() and dispose() are documented.

Location

  • API index: api/index.md — lists MRZScannerView and MRZResultView without links
  • Source: dist/mrz-scanner.d.ts

Recommended Fix

  1. Create documentation sections (or pages) for MRZScannerView and MRZResultView with their public methods.
  2. Add initialize() to the MRZScanner Methods section in api/mrz-scanner.md.
  3. Update api/index.md to link to the new sections.

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