From 48bfb5643fcda03c4f5b2fb8ffdb02a934cf8597 Mon Sep 17 00:00:00 2001
From: errhammr <errhammr@dismail.de>
Date: Thu, 26 Mar 2020 21:53:21 +0100
Subject: [PATCH] Improve JavaDoc in StartUI.java

---
 .../java/de/pixart/messenger/ui/StartUI.java   | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/src/main/java/de/pixart/messenger/ui/StartUI.java b/src/main/java/de/pixart/messenger/ui/StartUI.java
index d1fe6d084..e4ff43df4 100644
--- a/src/main/java/de/pixart/messenger/ui/StartUI.java
+++ b/src/main/java/de/pixart/messenger/ui/StartUI.java
@@ -22,10 +22,28 @@
 import pub.devrel.easypermissions.AfterPermissionGranted;
 import pub.devrel.easypermissions.EasyPermissions;
 
+/**
+ * This class is the entry point on startup. It checks whether or not the
+ * required permissions have been granted. The user will be asked to grant
+ * missing permissions.
+ */
 public class StartUI extends AppCompatActivity
         implements EasyPermissions.PermissionCallbacks {
 
+    /**
+     * Parameter {@code requestCode} for method
+     * {@code EasyPermissions#requestPermissions()}.
+     * @see pub.devrel.easypermissions.EasyPermissions#requestPermissions(Activity, String, int, String...) EasyPermissions#requestPermissions()
+     */
     private static final int NeededPermissions = 1000;
+
+    /**
+     * This array contains the essential permissions without which the app
+     * cannot operate.
+     * Parameter {@code perms} for method
+     * {@code EasyPermissions#requestPermissions()}.
+     * @see pub.devrel.easypermissions.EasyPermissions#requestPermissions(Activity, String, int, String...) EasyPermissions#requestPermissions()
+     */
     String[] perms = {Manifest.permission.READ_EXTERNAL_STORAGE,
             Manifest.permission.WRITE_EXTERNAL_STORAGE,
     };