tor-browser

commit e68a368611f58c25790811179d617cf14b0ef46a
parent dafc2e0f866c52f408bec298ac45cb53c7194779
Author: Mark Banner <standard8@mozilla.com>
Date:   Fri,  3 Oct 2025 14:09:08 +0000

Bug 1991124 - Fix ESLint require-jsdoc issues in genai code. r=firefox-ai-ml-reviewers,ngrato

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

Diffstat:
M
browser/components/genai/PageAssistChild.sys.mjs
 | 
3
+++
M
browser/components/genai/content/page-assist.mjs
 | 
6
++++++
M
browser/components/genai/content/smart-assist.mjs
 | 
6
++++++
M
browser/components/genai/tests/browser/browser_page_assist_actors.js
 | 
1
+
M
eslint-rollouts.config.mjs
 | 
4
----

5 files changed, 16 insertions(+), 4 deletions(-)
diff --git a/browser/components/genai/PageAssistChild.sys.mjs b/browser/components/genai/PageAssistChild.sys.mjs
@@ -8,6 +8,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
   Readerable: "resource://gre/modules/Readerable.sys.mjs",
 });
 
+/**
+ * Represents a child actor for getting page data from the browser.
+ */
 export class PageAssistChild extends JSWindowActorChild {
   async receiveMessage(message) {
     switch (message.name) {
diff --git a/browser/components/genai/content/page-assist.mjs b/browser/components/genai/content/page-assist.mjs
@@ -16,6 +16,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
 
 import MozInputText from "chrome://global/content/elements/moz-input-text.mjs";
 
+/**
+ * A custom element for managing the page assistant input.
+ */
 export class PageAssistInput extends MozInputText {
   static properties = {
     class: { type: String, reflect: true },
@@ -45,6 +48,9 @@ export class PageAssistInput extends MozInputText {
 }
 customElements.define("page-assists-input", PageAssistInput);
 
+/**
+ * A custom element for managing the page assistant sidebar.
+ */
 export class PageAssist extends MozLitElement {
   _progressListener = null;
   _onTabSelect = null;
diff --git a/browser/components/genai/content/smart-assist.mjs b/browser/components/genai/content/smart-assist.mjs
@@ -17,6 +17,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
 
 const FULL_PAGE_URL = "chrome://browser/content/genai/smartAssistPage.html";
 
+/**
+ * A custom element for managing the smart assistant sidebar.
+ */
 export class SmartAssist extends MozLitElement {
   static properties = {
     userPrompt: { type: String },
@@ -102,6 +105,9 @@ export class SmartAssist extends MozLitElement {
 
   /**
    * Mock Functionality to open full page UX
+   *
+   * @param {boolean} enable
+   *   Whether or not to override the new tab page.
    */
   _applyNewTabOverride(enable) {
     try {
diff --git a/browser/components/genai/tests/browser/browser_page_assist_actors.js b/browser/components/genai/tests/browser/browser_page_assist_actors.js
@@ -28,6 +28,7 @@ const TEST_LINK_URL_EN =
 /**
  * Helpers
  */
+
 function getPageAssistParentActor(browser) {
   return browser.browsingContext.currentWindowGlobal.getActor("PageAssist");
 }
diff --git a/eslint-rollouts.config.mjs b/eslint-rollouts.config.mjs
@@ -470,10 +470,6 @@ export default [
       // Bug 1991124 - Re-enable for these files which regressed whilst
       // require-jsdoc was accidentally not enabled.
       "browser/components/backup/tests/xpcshell/test_PreferencesBackupResource.js",
-      "browser/components/genai/PageAssistChild.sys.mjs",
-      "browser/components/genai/content/page-assist.mjs",
-      "browser/components/genai/content/smart-assist.mjs",
-      "browser/components/genai/tests/browser/browser_page_assist_actors.js",
       "browser/components/mozcachedohttp/MozCachedOHTTPProtocolHandler.sys.mjs",
       "browser/components/security/unexpectedScriptLoad.js",
       "browser/components/webrtc/content/webrtc-preview/webrtc-preview.mjs",