Add documentation to increase maintainablilty

Rename a variable
TeamNewPipe · Sep 17, 2023 · 95a97bb · 95a97bb
1 parent d1a82a8
commit 95a97bb
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 11 deletions.
diff --git a/app/src/main/java/org/schabi/newpipe/settings/VideoAudioSettingsFragment.java b/app/src/main/java/org/schabi/newpipe/settings/VideoAudioSettingsFragment.java
@@ -57,18 +57,17 @@ && getString(R.string.minimize_on_exit_key).equals(key)) {
 
     /**
      * Update default resolution, default popup resolution & mobile data resolution options.
-     * show high resolution when "Show higher resolution" option enabled.
+     * <br />
+     * Show high resolutions when "Show higher resolution" option is enabled.
+     * Set default resolution to "best resolution" when "Show higher resolution" option
+     * is disabled.
      */
     private void updateResolutionOptions() {
-        final ListPreference defaultResolution = findPreference(
-                getString(R.string.default_resolution_key));
-        final ListPreference defaultPopupResolution = findPreference(
-                getString(R.string.default_popup_resolution_key));
-        final ListPreference mobileDataResolution = findPreference(
-                getString(R.string.limit_mobile_data_usage_key));
         final Resources resources = getResources();
         final boolean showHigherResolutions =  getPreferenceManager().getSharedPreferences()
                 .getBoolean(resources.getString(R.string.show_higher_resolutions_key), false);
+
+        // get sorted resolution lists
         final List<String> resolutionListDescriptions = ListHelper.getSortedResolutionList(
                 resources,
                 R.array.resolution_list_description,
@@ -89,13 +88,26 @@ private void updateResolutionOptions() {
                 R.array.limit_data_usage_description_list,
                 R.array.high_resolution_list_descriptions,
                 showHigherResolutions);
+
+        // get resolution preferences
+        final ListPreference defaultResolution = findPreference(
+                getString(R.string.default_resolution_key));
+        final ListPreference defaultPopupResolution = findPreference(
+                getString(R.string.default_popup_resolution_key));
+        final ListPreference mobileDataResolution = findPreference(
+                getString(R.string.limit_mobile_data_usage_key));
+
+        // update resolution preferences with new resolutions, entries & values for each
         defaultResolution.setEntries(resolutionListDescriptions.toArray(new String[0]));
         defaultResolution.setEntryValues(resolutionListValues.toArray(new String[0]));
         defaultPopupResolution.setEntries(resolutionListDescriptions.toArray(new String[0]));
         defaultPopupResolution.setEntryValues(resolutionListValues.toArray(new String[0]));
         mobileDataResolution.setEntries(
                 limitDataUsageResolutionDescriptions.toArray(new String[0]));
         mobileDataResolution.setEntryValues(limitDataUsageResolutionValues.toArray(new String[0]));
+
+        // if "Show higher resolution" option is disabled,
+        // set default resolution to "best resolution"
         if (!showHigherResolutions) {
             if (ListHelper.isHighResolutionSelected(defaultResolution.getValue(),
                     R.array.high_resolution_list_values,

diff --git a/app/src/main/java/org/schabi/newpipe/util/ListHelper.java b/app/src/main/java/org/schabi/newpipe/util/ListHelper.java
@@ -240,20 +240,30 @@ public static List<VideoStream> getSortedStreamVideosList(
                 videoOnlyStreams, ascendingOrder, preferVideoOnlyStreams);
     }
 
+    /**
+     * Get a sorted list containing a set of default resolution info
+     * and additional resolution info if showHigherResolutions is true.
+     *
+     * @param resources the resources to get the resolutions from
+     * @param defaultResolutionKey the settings key of the default resolution
+     * @param additionalResolutionKey the settings key of the additional resolutions
+     * @param showHigherResolutions if higher resolutions should be included in the sorted list
+     * @return a sorted list containing the default and maybe additional resolutions
+     */
     public static List<String> getSortedResolutionList(
             final Resources resources,
             final int defaultResolutionKey,
             final int additionalResolutionKey,
             final boolean showHigherResolutions) {
-        final List<String> defaultResolution = new ArrayList<String>(Arrays.asList(
+        final List<String> resolutions = new ArrayList<>(Arrays.asList(
                 resources.getStringArray(defaultResolutionKey)));
         if (!showHigherResolutions) {
-            return defaultResolution;
+            return resolutions;
         }
         final List<String> additionalResolutions = Arrays.asList(
                 resources.getStringArray(additionalResolutionKey));
-        defaultResolution.addAll(1, additionalResolutions);
-        return defaultResolution;
+        resolutions.addAll(1, additionalResolutions);
+        return resolutions;
     }
 
     public static boolean isHighResolutionSelected(final String selectedResolution,