Navaron Bracke

rewrite some comments to avoid `NOTE` in capitals

... ... @@ -3,19 +3,17 @@ enum DetectionSpeed {
/// The scanner will only scan a barcode once, and never again until another
/// barcode has been scanned.
///
/// NOTE: This mode does analyze every frame in order to check if the value
/// has changed.
/// Bear in mind that this mode analyzes every frame,
/// in order to check if the value has changed.
noDuplicates(0),
/// The barcode scanner will scan one barcode, and wait 250 Miliseconds before
/// scanning again. This will prevent memory issues on older devices.
///
/// You can change the timeout duration with [detectionTimeout] parameter.
/// The barcode scanner will scan barcodes,
/// while respecting the configured scan timeout between individual scans.
normal(1),
/// Let the scanner detect barcodes without restriction.
/// The barcode scanner will scan barcodes, without any restrictions.
///
/// NOTE: This can cause memory issues with older devices.
/// Bear in mind that this mode can cause memory issues on older devices.
unrestricted(2);
const DetectionSpeed(this.rawValue);
... ...
... ... @@ -49,11 +49,13 @@ class MobileScannerController {
/// WARNING: DetectionSpeed.unrestricted can cause memory issues on some devices
final DetectionSpeed detectionSpeed;
/// Sets the timeout of scanner.
/// The timeout is set in miliseconds.
/// Sets the timeout, in milliseconds, of the scanner.
///
/// NOTE: The timeout only works if the [detectionSpeed] is set to
/// [DetectionSpeed.normal] (which is the default value).
/// This timeout is ignored if the [detectionSpeed]
/// is not set to [DetectionSpeed.normal].
///
/// By default this is set to `250` milliseconds,
/// which prevents memory issues on older devices.
final int detectionTimeoutMs;
/// Automatically start the mobileScanner on initialization.
... ...