Skip to content

Commit e68a368

Browse files
committed
Bug 1991124 - Fix ESLint require-jsdoc issues in genai code. r=firefox-ai-ml-reviewers,ngrato
Differential Revision: https://phabricator.services.mozilla.com/D266631
1 parent dafc2e0 commit e68a368

File tree

5 files changed

+16
-4
lines changed

5 files changed

+16
-4
lines changed

browser/components/genai/PageAssistChild.sys.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
88
Readerable: "resource://gre/modules/Readerable.sys.mjs",
99
});
1010

11+
/**
12+
* Represents a child actor for getting page data from the browser.
13+
*/
1114
export class PageAssistChild extends JSWindowActorChild {
1215
async receiveMessage(message) {
1316
switch (message.name) {

browser/components/genai/content/page-assist.mjs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
1616

1717
import MozInputText from "chrome://global/content/elements/moz-input-text.mjs";
1818

19+
/**
20+
* A custom element for managing the page assistant input.
21+
*/
1922
export class PageAssistInput extends MozInputText {
2023
static properties = {
2124
class: { type: String, reflect: true },
@@ -45,6 +48,9 @@ export class PageAssistInput extends MozInputText {
4548
}
4649
customElements.define("page-assists-input", PageAssistInput);
4750

51+
/**
52+
* A custom element for managing the page assistant sidebar.
53+
*/
4854
export class PageAssist extends MozLitElement {
4955
_progressListener = null;
5056
_onTabSelect = null;

browser/components/genai/content/smart-assist.mjs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ ChromeUtils.defineESModuleGetters(lazy, {
1717

1818
const FULL_PAGE_URL = "chrome://browser/content/genai/smartAssistPage.html";
1919

20+
/**
21+
* A custom element for managing the smart assistant sidebar.
22+
*/
2023
export class SmartAssist extends MozLitElement {
2124
static properties = {
2225
userPrompt: { type: String },
@@ -102,6 +105,9 @@ export class SmartAssist extends MozLitElement {
102105

103106
/**
104107
* Mock Functionality to open full page UX
108+
*
109+
* @param {boolean} enable
110+
* Whether or not to override the new tab page.
105111
*/
106112
_applyNewTabOverride(enable) {
107113
try {

browser/components/genai/tests/browser/browser_page_assist_actors.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ const TEST_LINK_URL_EN =
2828
/**
2929
* Helpers
3030
*/
31+
3132
function getPageAssistParentActor(browser) {
3233
return browser.browsingContext.currentWindowGlobal.getActor("PageAssist");
3334
}

eslint-rollouts.config.mjs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -470,10 +470,6 @@ export default [
470470
// Bug 1991124 - Re-enable for these files which regressed whilst
471471
// require-jsdoc was accidentally not enabled.
472472
"browser/components/backup/tests/xpcshell/test_PreferencesBackupResource.js",
473-
"browser/components/genai/PageAssistChild.sys.mjs",
474-
"browser/components/genai/content/page-assist.mjs",
475-
"browser/components/genai/content/smart-assist.mjs",
476-
"browser/components/genai/tests/browser/browser_page_assist_actors.js",
477473
"browser/components/mozcachedohttp/MozCachedOHTTPProtocolHandler.sys.mjs",
478474
"browser/components/security/unexpectedScriptLoad.js",
479475
"browser/components/webrtc/content/webrtc-preview/webrtc-preview.mjs",

0 commit comments

Comments
 (0)