chore: add documentation that was missing

References: https://outsystemsrd.atlassian.net/browse/RMET-2912
OutSystems · Dec 7, 2023 · bfa1cad · bfa1cad
1 parent b9cf534
commit bfa1cad
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/...ain/kotlin/com/outsystems/plugins/barcode/controller/helper/OSBARCImageHelperInterface.kt b/...ain/kotlin/com/outsystems/plugins/barcode/controller/helper/OSBARCImageHelperInterface.kt
@@ -2,6 +2,9 @@ package com.outsystems.plugins.barcode.controller.helper
 
 import android.graphics.Bitmap
 
+/**
+ * Interface that provides the signature of the type's methods.
+ */
 interface OSBARCImageHelperInterface {
     fun bitmapFromImageBytes(imageBytes: ByteArray): Bitmap
     fun createSubsetBitmapFromSource(

diff --git a/src/main/kotlin/com/outsystems/plugins/barcode/controller/helper/OSBARCMLKitHelper.kt b/src/main/kotlin/com/outsystems/plugins/barcode/controller/helper/OSBARCMLKitHelper.kt
@@ -7,7 +7,6 @@ import com.google.mlkit.vision.barcode.BarcodeScannerOptions
 import com.google.mlkit.vision.barcode.BarcodeScanning
 import com.google.mlkit.vision.barcode.common.Barcode
 import com.google.mlkit.vision.common.InputImage
-import kotlinx.coroutines.runBlocking
 
 /**
  * Helper class that implements the OSBARCMLKitHelperInterface

diff --git a/src/main/kotlin/com/outsystems/plugins/barcode/view/OSBARCScannerActivity.kt b/src/main/kotlin/com/outsystems/plugins/barcode/view/OSBARCScannerActivity.kt
@@ -193,6 +193,8 @@ class OSBARCScannerActivity : ComponentActivity() {
     /**
      * Composable function, responsible for declaring the UI of the screen,
      * as well as creating an instance of OSBARCBarcodeAnalyzer for image analysis.
+     * @param parameters the scan parameters
+     * @param windowSizeClass WindowSizeClass object to determine device type - phone or tablet
      */
     @Composable
     fun ScanScreen(parameters: OSBARCScanParameters, windowSizeClass: WindowSizeClass) {
@@ -294,6 +296,12 @@ class OSBARCScannerActivity : ComponentActivity() {
         }
     }
 
+    /**
+     * Composable function, responsible for determining which UI
+     * should be rendered: portrait or landscape
+     * @param parameters the scan parameters
+     * @param windowSizeClass WindowSizeClass object to determine device type - phone or tablet
+     */
     @Composable
     fun ScanScreenUI(parameters: OSBARCScanParameters, windowSizeClass: WindowSizeClass) {
         // actual UI on top of the camera stream

diff --git a/src/main/kotlin/com/outsystems/plugins/barcode/view/ui.theme/Sizes.kt b/src/main/kotlin/com/outsystems/plugins/barcode/view/ui.theme/Sizes.kt
@@ -14,5 +14,5 @@ val ScanButtonCornerRadius = 4f.dp
 val ScanButtonStrokeWidth = 1f.dp
 val ActionButtonsDistance = 48f.dp
 
-val SizeRatioWidth = 0.6
-val SizeRatioHeight = 0.5
+const val SizeRatioWidth = 0.6
+const val SizeRatioHeight = 0.5