docs(barcode-scanning): add more comments

capawesome-team · Oct 11, 2023 · 88e3964 · 88e3964
1 parent 6b6cf45
commit 88e3964
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/barcode-scanning/README.md b/packages/barcode-scanning/README.md
@@ -335,7 +335,8 @@ Scan a barcode with a ready-to-use interface without WebView customization.
 On **Android**, this method is only available on devices with Google Play Services
 installed. Therefore, no camera permission is required.
 
-**Attention:** Before using this method on *Android*, first check if the Google <a href="#barcode">Barcode</a> Scanner module is available.
+**Attention:** Before using this method on *Android*, first check if the Google <a href="#barcode">Barcode</a> Scanner module is available
+by using `isGoogleBarcodeScannerModuleAvailable()`.
 
 Only available on Android and iOS.
 
@@ -469,6 +470,8 @@ isGoogleBarcodeScannerModuleAvailable() => Promise<IsGoogleBarcodeScannerModuleA
 
 Check if the Google <a href="#barcode">Barcode</a> Scanner module is available.
 
+If the Google <a href="#barcode">Barcode</a> Scanner module is not available, you can install it by using `installGoogleBarcodeScannerModule()`.
+
 Only available on Android.
 
 **Returns:** <code>Promise&lt;<a href="#isgooglebarcodescannermoduleavailableresult">IsGoogleBarcodeScannerModuleAvailableResult</a>&gt;</code>

diff --git a/packages/barcode-scanning/src/definitions.ts b/packages/barcode-scanning/src/definitions.ts
@@ -33,7 +33,8 @@ export interface BarcodeScannerPlugin {
    * On **Android**, this method is only available on devices with Google Play Services
    * installed. Therefore, no camera permission is required.
    *
-   * **Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available.
+   * **Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available
+   * by using `isGoogleBarcodeScannerModuleAvailable()`.
    *
    * Only available on Android and iOS.
    *
@@ -100,6 +101,8 @@ export interface BarcodeScannerPlugin {
   /**
    * Check if the Google Barcode Scanner module is available.
    *
+   * If the Google Barcode Scanner module is not available, you can install it by using `installGoogleBarcodeScannerModule()`.
+   *
    * Only available on Android.
    *
    * @since 5.1.0