Navaron Bracke

fix docs for barcode capture

  1 +/// @docImport 'package:mobile_scanner/src/mobile_scanner_controller.dart';
  2 +library;
  3 +
1 import 'dart:typed_data'; 4 import 'dart:typed_data';
2 import 'dart:ui'; 5 import 'dart:ui';
3 6
@@ -16,15 +19,21 @@ class BarcodeCapture { @@ -16,15 +19,21 @@ class BarcodeCapture {
16 /// The list of scanned barcodes. 19 /// The list of scanned barcodes.
17 final List<Barcode> barcodes; 20 final List<Barcode> barcodes;
18 21
19 - /// The bytes of the image that is embedded in the barcode. 22 + /// The input image of the barcode capture.
  23 + ///
  24 + /// This is the image that was used to detect the available [barcodes],
  25 + /// not the image from a specific barcode.
20 /// 26 ///
21 - /// This null if [MobileScannerController.returnImage] is false,  
22 - /// or if there is no available image. 27 + /// This is always null if [MobileScannerController.returnImage] is false.
23 final Uint8List? image; 28 final Uint8List? image;
24 29
25 - /// The raw data of the scanned barcode. 30 + /// The raw data of the barcode scan.
  31 + ///
  32 + /// This is the data that was used to detect the available [barcodes], the input [image] and the [size].
26 final Object? raw; 33 final Object? raw;
27 34
28 - /// The size of the scanned barcode. 35 + /// The size of the input [image].
  36 + ///
  37 + /// If [image] is null, this will be [Size.zero].
29 final Size size; 38 final Size size;
30 } 39 }