From fd6c66a86a730335158468c27b24319d6c578daa Mon Sep 17 00:00:00 2001
From: Sylvia van Os <sylvia@hackerchick.me>
Date: Tue, 21 Jan 2020 20:06:58 +0100
Subject: [PATCH] Improve documentation

---
 .../card_locker/LoyaltyCardViewActivity.java  | 23 +++++++++++++------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/app/src/main/java/protect/card_locker/LoyaltyCardViewActivity.java b/app/src/main/java/protect/card_locker/LoyaltyCardViewActivity.java
index edeaf63b9..f91014d68 100644
--- a/app/src/main/java/protect/card_locker/LoyaltyCardViewActivity.java
+++ b/app/src/main/java/protect/card_locker/LoyaltyCardViewActivity.java
@@ -119,11 +119,11 @@ public class LoyaltyCardViewActivity extends AppCompatActivity
             public void onClick(View view) {
                 if(barcodeIsFullscreen)
                 {
-                    setBarcodeFullscreen(false);
+                    setFullscreen(false);
                 }
                 else
                 {
-                    setBarcodeFullscreen(true);
+                    setFullscreen(true);
                 }
             }
         });
@@ -147,7 +147,10 @@ public class LoyaltyCardViewActivity extends AppCompatActivity
 
         if(barcodeIsFullscreen)
         {
-            // Properly reset state to prevent any issues
+            // Completely reset state
+            //
+            // This prevents the barcode from taking up the entire screen
+            // on resume and thus being stretched out of proportion.
             recreate();
         }
 
@@ -277,7 +280,7 @@ public class LoyaltyCardViewActivity extends AppCompatActivity
     public void onBackPressed() {
         if (barcodeIsFullscreen)
         {
-            setBarcodeFullscreen(false);
+            setFullscreen(false);
             return;
         }
 
@@ -363,10 +366,16 @@ public class LoyaltyCardViewActivity extends AppCompatActivity
         }
     }
 
-    private void setBarcodeFullscreen(boolean enabled)
+    /**
+     * When enabled, hides the status bar and moves the barcode to the top of the screen.
+     *
+     * The purpose of this function is to make sure the barcode can be scanned from the phone
+     * by machines which offer no space to insert the complete device.
+     */
+    private void setFullscreen(boolean enable)
     {
         ActionBar actionBar = getSupportActionBar();
-        if(enabled && !barcodeIsFullscreen)
+        if(enable && !barcodeIsFullscreen)
         {
             // Save previous barcodeImage state
             barcodeImageState = barcodeImage.getLayoutParams();
@@ -399,7 +408,7 @@ public class LoyaltyCardViewActivity extends AppCompatActivity
             // Set current state
             barcodeIsFullscreen = true;
         }
-        else if(!enabled && barcodeIsFullscreen)
+        else if(!enable && barcodeIsFullscreen)
         {
             // Show actionbar
             if(actionBar != null)