Finish adding documentation to all files

Author: Stypox

app/build.gradle.kts

@@ -55,7 +55,9 @@ configure<ApplicationExtension> {
         System.getProperty("versionNameSuffix")?.let { versionNameSuffix = it }
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        // https://blog.grobox.de/2019/disable-google-android-instrumentation-test-tracking/
         testInstrumentationRunnerArguments["disableAnalytics"] = "true"
+        // https://developer.android.com/studio/test/espresso-api#set_up_your_project_for_the_espresso_device_api
         testOptions {
             emulatorControl {
                 enable = true

app/src/androidTest/java/org/schabi/newpipe/ui/components/menu/LongPressMenuEditorTest.kt

@@ -261,7 +261,7 @@ class LongPressMenuEditorTest {
         assertActionEnabledStatus(label = Enqueue.label, expectedEnabled = true)
         assertActionEnabledStatus(label = EnqueueNext.label, expectedEnabled = true)
         assertActionEnabledStatus(label = R.string.long_press_menu_header, expectedEnabled = true)
-        closeEditorAndAssertNewSettings(isHeaderEnabled = true, actionArrangement = getDefaultEnabledLongPressActions(ctx))
+        closeEditorAndAssertNewSettings(isHeaderEnabled = true, actionArrangement = getDefaultLongPressActionArrangement(ctx))
     }
 
     @Test

app/src/androidTest/java/org/schabi/newpipe/ui/components/menu/LongPressMenuSettingsTest.kt

@@ -44,13 +44,13 @@ class LongPressMenuSettingsTest {
     @Test
     fun testLoadingActionArrangementUnset() {
         clearPrefs()
-        assertEquals(getDefaultEnabledLongPressActions(ctx), loadLongPressActionArrangementFromSettings(ctx))
+        assertEquals(getDefaultLongPressActionArrangement(ctx), loadLongPressActionArrangementFromSettings(ctx))
     }
 
     @Test
     fun testLoadingActionArrangementInvalid() {
         putStringInPrefs(R.string.long_press_menu_action_arrangement_key, "0,1,whatever,3")
-        assertEquals(getDefaultEnabledLongPressActions(ctx), loadLongPressActionArrangementFromSettings(ctx))
+        assertEquals(getDefaultLongPressActionArrangement(ctx), loadLongPressActionArrangementFromSettings(ctx))
     }
 
     @Test
@@ -73,7 +73,7 @@ class LongPressMenuSettingsTest {
     fun testDefaultActionsIncludeKodiIffShowKodiEnabled() {
         for (enabled in arrayOf(false, true)) {
             putBooleanInPrefs(R.string.show_play_with_kodi_key, enabled)
-            val actions = getDefaultEnabledLongPressActions(ctx)
+            val actions = getDefaultLongPressActionArrangement(ctx)
             assertEquals(enabled, actions.contains(PlayWithKodi))
         }
     }
@@ -85,7 +85,7 @@ class LongPressMenuSettingsTest {
             for (actions in listOf(listOf(Enqueue), listOf(Enqueue, PlayWithKodi))) {
                 storeLongPressActionArrangementToSettings(ctx, actions)
                 addOrRemoveKodiLongPressAction(ctx)
-                val newActions = getDefaultEnabledLongPressActions(ctx)
+                val newActions = getDefaultLongPressActionArrangement(ctx)
                 assertEquals(enabled, newActions.contains(PlayWithKodi))
             }
         }

app/src/androidTest/java/org/schabi/newpipe/ui/components/menu/LongPressMenuTest.kt

@@ -21,12 +21,10 @@ import androidx.compose.ui.test.isNotDisplayed
 import androidx.compose.ui.test.junit4.createAndroidComposeRule
 import androidx.compose.ui.test.onAllNodesWithTag
 import androidx.compose.ui.test.onFirst
-import androidx.compose.ui.test.onNodeWithContentDescription
 import androidx.compose.ui.test.onNodeWithTag
 import androidx.compose.ui.test.onNodeWithText
 import androidx.compose.ui.test.performClick
 import androidx.compose.ui.unit.dp
-import androidx.test.espresso.Espresso
 import androidx.test.espresso.Espresso.onView
 import androidx.test.espresso.assertion.ViewAssertions.doesNotExist
 import androidx.test.espresso.assertion.ViewAssertions.matches
@@ -508,8 +506,8 @@ class LongPressMenuTest {
     fun testOnlyAndAllArrangedActionsDisplayed3() {
         assertOnlyAndAllArrangedActionsDisplayed(
             availableActions = LongPressAction.Type.entries,
-            actionArrangement = getDefaultEnabledLongPressActions(ctx),
-            expectedShownActions = getDefaultEnabledLongPressActions(ctx)
+            actionArrangement = getDefaultLongPressActionArrangement(ctx),
+            expectedShownActions = getDefaultLongPressActionArrangement(ctx)
         )
     }
 
@@ -534,9 +532,9 @@ class LongPressMenuTest {
     @Test
     fun testOnlyAndAllAvailableActionsDisplayed3() {
         assertOnlyAndAllArrangedActionsDisplayed(
-            availableActions = getDefaultEnabledLongPressActions(ctx),
+            availableActions = getDefaultLongPressActionArrangement(ctx),
             actionArrangement = LongPressAction.Type.entries,
-            expectedShownActions = getDefaultEnabledLongPressActions(ctx)
+            expectedShownActions = getDefaultLongPressActionArrangement(ctx)
         )
     }
 

app/src/main/java/org/schabi/newpipe/ui/GestureModifiers.kt

@@ -67,15 +67,17 @@ fun Modifier.detectDragGestures(
                     return@withTimeout false
                 }
             } catch (_: PointerEventTimeoutCancellationException) {
-                true
+                true // the timeout fired, so the "press" is indeed "long"
             }
 
             val pointerId = down.id
+            // importantly, tell `beginDragGesture` whether the drag begun with a long press
             beginDragGesture(down.position.toIntOffset(), wasLongPressed)
             while (true) {
+                // go through all events of this gesture and feed them to `handleDragGestureChange`
                 val change = awaitPointerEvent().changes.find { it.id == pointerId }
                 if (change == null || !change.pressed) {
-                    break
+                    break // the gesture finished
                 }
                 handleDragGestureChange(
                     change.position.toIntOffset(),
@@ -97,7 +99,7 @@ private fun Offset.toIntOffset() = IntOffset(this.x.toInt(), this.y.toInt())
 fun Modifier.discardAllTouchesIf(doDiscard: Boolean) = if (doDiscard) {
     pointerInput(Unit) {
         awaitPointerEventScope {
-            // we should wait for all new pointer events
+            // we should wait for all new pointer events and ignore them all
             while (true) {
                 awaitPointerEvent(pass = PointerEventPass.Initial)
                     .changes

app/src/main/java/org/schabi/newpipe/ui/components/menu/LongPressMenu.kt

@@ -832,11 +832,7 @@ private fun LongPressMenuPreview(
         onDispose {}
     }
 
-    // the incorrect theme is set when running the preview in an emulator for some reason...
-    val initialUseDarkTheme = isSystemInDarkTheme()
-    var useDarkTheme by remember { mutableStateOf(initialUseDarkTheme) }
-
-    AppTheme(useDarkTheme = useDarkTheme) {
+    AppTheme {
         Surface(color = MaterialTheme.colorScheme.surfaceContainerLow) {
             // longPressable is null when running the preview in an emulator for some reason...
             @Suppress("USELESS_ELVIS")