all: general cleanup

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Item and sort menus have been refreshed with a cleaner look
 - Added ability to sort playlists
 - Added option to play song by itself in library/item details
+- Added error details when music loading fails
 
 #### What's Improved
 - Made "Add to Playlist" action more prominent in selection toolbar

app/src/main/java/org/oxycblt/auxio/home/ErrorDetailsDialog.kt

@@ -35,9 +35,9 @@ import org.oxycblt.auxio.util.showToast
 /**
  * A dialog that shows a stack trace for a music loading error.
  *
- * TODO: Extend to other errors
- *
  * @author Alexander Capehart (OxygenCobalt)
+ *
+ * TODO: Extend to other errors
  */
 class ErrorDetailsDialog : ViewBindingMaterialDialogFragment<DialogErrorDetailsBinding>() {
     private val args: ErrorDetailsDialogArgs by navArgs()

app/src/main/java/org/oxycblt/auxio/ui/DialogAwareNavigationListener.kt

@@ -24,7 +24,10 @@ import androidx.navigation.NavDestination
 
 /**
  * A [NavController.OnDestinationChangedListener] that will call [callback] when moving between
- * fragments only (not between dialogs or anything similar)
+ * fragments only (not between dialogs or anything similar).
+ *
+ * Note: This only works because of special naming used in Auxio's navigation graphs. Keep this in
+ * mind when porting to other projects.
  *
  * @author Alexander Capehart (OxygenCobalt)
  */
@@ -74,6 +77,5 @@ class DialogAwareNavigationListener(private val callback: () -> Unit) :
         }
     }
 
-    /** This relies on special label naming used in-app. */
     private fun NavDestination.isDialog() = label?.endsWith("dialog") == true
 }