Add a lot of code documentation (#1145)

## Description
A brain dump documenting many classes and functions throughout the app.
Definitely does not document everything, but covers most of the major
components. This should be useful for new contributors.

There is a small amount of code clean up too.

There are no user facing changes.

### Related issues
N/A

### Testing
N/A

## Screenshots
N/A

## AI or LLM usage
None
This commit is contained in:
Ray 2026-03-29 10:52:25 -04:00 committed by GitHub
parent 2485d2c644
commit 66f060dccb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
92 changed files with 719 additions and 222 deletions

View file

@ -1,14 +1,10 @@
commit f82fb1a2d8ff9917a7bdb0bc7101a0474359ccdc
Author: Damontecres <damontecres@gmail.com>
Date: Sat Nov 22 13:00:55 2025 -0500
# This patches Wholphin for releasing on app stores where self updating is not permitted
Setup for play store
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
index 6d84299..12576af 100644
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -4,7 +4,6 @@
diff --git i/app/src/main/AndroidManifest.xml w/app/src/main/AndroidManifest.xml
index 4479ae86..80596698 100644
--- i/app/src/main/AndroidManifest.xml
+++ w/app/src/main/AndroidManifest.xml
@@ -6,7 +6,6 @@
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
@ -16,7 +12,7 @@ index 6d84299..12576af 100644
<uses-permission
android:name="android.permission.WRITE_EXTERNAL_STORAGE"
android:maxSdkVersion="28" />
@@ -17,7 +16,7 @@
@@ -20,7 +19,7 @@
android:required="false" />
<uses-feature
android:name="android.software.leanback"
@ -25,11 +21,11 @@ index 6d84299..12576af 100644
<uses-feature
android:name="android.hardware.microphone"
android:required="false" />
diff --git a/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt b/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
index c7ac435..fa42fe1 100644
--- a/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
+++ b/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
@@ -62,7 +62,7 @@ class UpdateChecker
diff --git i/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt w/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
index 9e0665dd..bc1e1c16 100644
--- i/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
+++ w/app/src/main/java/com/github/damontecres/wholphin/services/UpdateChecker.kt
@@ -65,7 +65,7 @@ class UpdateChecker
private val NOTE_REGEX = Regex("<!-- app-note:(.+) -->")
@ -37,4 +33,4 @@ index c7ac435..fa42fe1 100644
+ val ACTIVE = false
}
suspend fun maybeShowUpdateToast(
/**