Bug 1870226 - Fix missing jsdoc @returns for search code. r=search-reviewers,jteow

Differential Revision: https://phabricator.services.mozilla.com/D219507

browser/components/search/SearchUIUtils.sys.mjs

@@ -44,7 +44,9 @@ export var SearchUIUtils = {
    *   icon. This value may be overridden by an icon specified in the
    *   engine description file.
    * @param {object} browsingContext
-   *  The browsing context any error prompt should be opened for.
+   *   The browsing context any error prompt should be opened for.
+   * @returns {boolean}
+   *   Returns true if the engine was added.
    */
   async addOpenSearchEngine(locationURL, image, browsingContext) {
     try {

toolkit/components/search/SearchEngineSelector.sys.mjs

@@ -54,6 +54,9 @@ export class SearchEngineSelector {
 
   /**
    * Handles getting the configuration from remote settings.
+   *
+   * @returns {object}
+   *   The configuration data.
    */
   async getEngineConfiguration() {
     if (this._getConfigurationPromise) {
@@ -90,6 +93,9 @@ export class SearchEngineSelector {
 
   /**
    * Used by tests to get the configuration overrides.
+   *
+   * @returns {object}
+   *   The engine overrides data.
    */
   async getEngineConfigurationOverrides() {
     await this.getEngineConfiguration();

toolkit/components/search/tests/SearchTestUtils.sys.mjs

@@ -365,6 +365,8 @@ class _SearchTestUtils {
    *
    * @param {Array} engineConfigurations
    *   An array of engine configurations.
+   * @returns {AppProvidedSearchEngine[]}
+   *   An array of app provided search engine objects.
    */
   async searchConfigToEngines(engineConfigurations) {
     return engineConfigurations.map(

toolkit/components/search/tests/xpcshell/head_search.js

@@ -325,6 +325,8 @@ async function getFileDataBuffer(filename) {
  *   The ID to use for the record. If not provided, a new UUID will be generated.
  * @param {number} [item.lastModified]
  *   The last modified time for the record. Defaults to the current time.
+ * @returns {object}
+ *   An object containing the record and attachment.
  */
 async function mockRecordWithAttachment({
   filename,