Add JSDoc comment to getItems helper

In return the comments at each usage are removed.

src/components/notifications/notifications.js

@@ -131,8 +131,6 @@ function onLibraryChanged(data, apiClient) {
         newItems.length = 12;
     }
 
-    // call getItems from jellyfin-apiclient/getItems.ts instead of apiClient.getItems()
-    // to split up into multiple requests if necessary (URL might get too long)
     getItems(apiClient, apiClient.getCurrentUserId(), {
 
         Recursive: true,

src/components/playback/playbackmanager.js

@@ -128,8 +128,6 @@ function getItemsForPlayback(serverId, query) {
         query.EnableTotalRecordCount = false;
         query.CollapseBoxSetItems = false;
 
-        // call getItems from jellyfin-apiclient/getItems.ts instead of apiClient.getItems()
-        // to split up into multiple requests if necessary (URL might get too long)
         return getItems(apiClient, apiClient.getCurrentUserId(), query);
     }
 }

src/plugins/chromecastPlayer/plugin.js

@@ -483,8 +483,6 @@ function getItemsForPlayback(apiClient, query) {
         query.ExcludeLocationTypes = 'Virtual';
         query.EnableTotalRecordCount = false;
 
-        // call getItems from jellyfin-apiclient/getItems.ts instead of apiClient.getItems()
-        // to split up into multiple requests if necessary (URL might get too long)
         return getItems(apiClient, userId, query);
     }
 }

src/plugins/syncPlay/core/Helper.js

@@ -89,8 +89,6 @@ export function getItemsForPlayback(apiClient, query) {
         query.EnableTotalRecordCount = false;
         query.CollapseBoxSetItems = false;
 
-        // call getItems from jellyfin-apiclient/getItems.ts instead of apiClient.getItems()
-        // to split up into multiple requests if necessary (URL might get too long)
         return getItems(apiClient, apiClient.getCurrentUserId(), query);
     }
 }

src/utils/jellyfin-apiclient/getItems.ts

@@ -49,6 +49,14 @@ function mergeResults(results: BaseItemDtoQueryResult[]) {
     return merged;
 }
 
+/**
+ * Transparently handles the call to apiClient.getItems splitting the
+ * call into multiple ones if the URL might get too long.
+ * @param apiClient The ApiClient to use
+ * @param userId User id to pass to actual getItems call
+ * @param options Options object to specify getItems option. This includes a possibly long Items list that will be split up.
+ * @returns A promise that resolves to the merged result of all getItems calls
+ */
 export function getItems(apiClient: ApiClient, userId: string, options?: any) {
     if (options.Ids?.split(',').length <= ITEMS_PER_REQUEST_LIMIT) {
         return apiClient.getItems(apiClient.getCurrentUserId(), options);