Bug 1991124 - Fix ESLint require-jsdoc issues in urlbar and search code. r=urlbar-reviewers,search-reviewers,scunnane,dao

marco-c · marco-c · commit 5e0bec8f5a9f · 2025-10-08T09:41:24.000Z
Differential Revision: https://phabricator.services.mozilla.com/D266628 UltraBlame original commit: 75e6b2958acc22b5f96e5795c2ed639bd796d150
diff --git a/browser/components/urlbar/SearchModeSwitcher.sys.mjs b/browser/components/urlbar/SearchModeSwitcher.sys.mjs
@@ -2502,6 +2502,13 @@ the
 popup
 .
 *
+*
+param
+{
+Element
+}
+separator
+*
 /
 async
 #
diff --git a/browser/components/urlbar/UrlbarProviderAutofill.sys.mjs b/browser/components/urlbar/UrlbarProviderAutofill.sys.mjs
@@ -2023,12 +2023,22 @@ UrlbarResult
 }
 result
 *
+The
+result
+entry
+.
+*
 property
 {
 Query
 }
 instance
 *
+The
+query
+instance
+.
+*
 /
 /
 *
diff --git a/browser/components/urlbar/UrlbarResult.sys.mjs b/browser/components/urlbar/UrlbarResult.sys.mjs
@@ -306,6 +306,14 @@ string
 qsSuggestion
 ]
 *
+The
+suggestion
+text
+from
+quick
+suggest
+.
+*
 /
 /
 *
diff --git a/browser/components/urlbar/UrlbarSearchTermsPersistence.sys.mjs b/browser/components/urlbar/UrlbarSearchTermsPersistence.sys.mjs
@@ -158,6 +158,18 @@ string
 }
 providerId
 *
+The
+search
+engine
+provider
+id
+associated
+with
+the
+persisted
+terms
+.
+*
 property
 {
 RegExp
@@ -166,6 +178,19 @@ RegExp
 searchPageRegexp
 ]
 *
+The
+regular
+expression
+for
+determining
+if
+the
+search
+page
+URL
+matches
+.
+*
 property
 {
 {
@@ -186,6 +211,22 @@ boolean
 }
 includeParams
 *
+The
+parameters
+that
+should
+be
+included
+in
+determining
+if
+the
+search
+page
+URL
+matches
+.
+*
 property
 {
 {
@@ -203,6 +244,22 @@ string
 }
 excludeParams
 *
+The
+parameters
+that
+should
+be
+excluded
+in
+determining
+if
+the
+search
+page
+URL
+matches
+.
+*
 /
 ChromeUtils
 .
diff --git a/browser/components/urlbar/private/MLSuggest.sys.mjs b/browser/components/urlbar/private/MLSuggest.sys.mjs
@@ -433,6 +433,20 @@ purposes
 .
 *
 *
+param
+{
+object
+}
+options
+*
+Configuration
+options
+for
+the
+ML
+engine
+.
+*
 returns
 {
 MLEngine
@@ -441,15 +455,15 @@ MLEngine
 /
 createEngine
 (
-args
+options
 )
 {
 return
 lazy
 .
 createEngine
 (
-args
+options
 )
 ;
 }
diff --git a/browser/components/urlbar/private/YelpSuggestions.sys.mjs b/browser/components/urlbar/private/YelpSuggestions.sys.mjs
@@ -1655,6 +1655,13 @@ RESULT_MENU_COMMAND
 name
 ]
 *
+The
+name
+of
+the
+command
+.
+*
 property
 {
 {
@@ -1667,6 +1674,19 @@ string
 l10n
 ]
 *
+The
+id
+of
+the
+l10n
+string
+to
+use
+for
+the
+translation
+.
+*
 /
 /
 *
diff --git a/eslint-rollouts.config.mjs b/eslint-rollouts.config.mjs
@@ -5106,21 +5106,6 @@ browser
 /
 components
 /
-search
-/
-content
-/
-autocomplete
--
-popup
-.
-js
-"
-"
-browser
-/
-components
-/
 security
 /
 unexpectedScriptLoad
@@ -5132,105 +5117,6 @@ browser
 /
 components
 /
-urlbar
-/
-SearchModeSwitcher
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-UrlbarProviderAutofill
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-UrlbarResult
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-UrlbarSearchTermsPersistence
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-private
-/
-MLSuggest
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-private
-/
-YelpSuggestions
-.
-sys
-.
-mjs
-"
-"
-browser
-/
-components
-/
-urlbar
-/
-tests
-/
-engagementTelemetry
-/
-browser
-/
-head
-.
-js
-"
-"
-browser
-/
-components
-/
 webrtc
 /
 content
@@ -5261,19 +5147,6 @@ mjs
 "
 toolkit
 /
-components
-/
-search
-/
-SearchSuggestionController
-.
-sys
-.
-mjs
-"
-"
-toolkit
-/
 modules
 /
 AppServicesTracing
diff --git a/toolkit/components/search/SearchSuggestionController.sys.mjs b/toolkit/components/search/SearchSuggestionController.sys.mjs
@@ -1989,6 +1989,16 @@ string
 }
 term
 *
+The
+search
+term
+used
+for
+obtaining
+the
+suggestions
+.
+*
 property
 {
 FormHistoryResultType
@@ -1997,6 +2007,19 @@ FormHistoryResultType
 formHistoryResults
 ]
 *
+The
+results
+in
+a
+form
+history
+result
+object
+used
+for
+SearchSuggestions
+.
+*
 property
 {
 Array

Original file line number	Diff line number	Diff line change
`@@ -2502,6 +2502,13 @@ the`
`2502`	`2502`	`popup`
`2503`	`2503`	`.`
`2504`	`2504`	`*`
	`2505`	`+*`
	`2506`	`+param`
	`2507`	`+{`
	`2508`	`+Element`
	`2509`	`+}`
	`2510`	`+separator`
	`2511`	`+*`
`2505`	`2512`	`/`
`2506`	`2513`	`async`
`2507`	`2514`	`#`
Original file line number	Diff line number	Diff line change
`@@ -2023,12 +2023,22 @@ UrlbarResult`
`2023`	`2023`	`}`
`2024`	`2024`	`result`
`2025`	`2025`	`*`
	`2026`	`+The`
	`2027`	`+result`
	`2028`	`+entry`
	`2029`	`+.`
	`2030`	`+*`
`2026`	`2031`	`property`
`2027`	`2032`	`{`
`2028`	`2033`	`Query`
`2029`	`2034`	`}`
`2030`	`2035`	`instance`
`2031`	`2036`	`*`
	`2037`	`+The`
	`2038`	`+query`
	`2039`	`+instance`
	`2040`	`+.`
	`2041`	`+*`
`2032`	`2042`	`/`
`2033`	`2043`	`/`
`2034`	`2044`	`*`
Original file line number	Diff line number	Diff line change
`@@ -306,6 +306,14 @@ string`
`306`	`306`	`qsSuggestion`
`307`	`307`	`]`
`308`	`308`	`*`
	`309`	`+The`
	`310`	`+suggestion`
	`311`	`+text`
	`312`	`+from`
	`313`	`+quick`
	`314`	`+suggest`
	`315`	`+.`
	`316`	`+*`
`309`	`317`	`/`
`310`	`318`	`/`
`311`	`319`	`*`
Original file line number	Diff line number	Diff line change
`@@ -433,6 +433,20 @@ purposes`
`433`	`433`	`.`
`434`	`434`	`*`
`435`	`435`	`*`
	`436`	`+param`
	`437`	`+{`
	`438`	`+object`
	`439`	`+}`
	`440`	`+options`
	`441`	`+*`
	`442`	`+Configuration`
	`443`	`+options`
	`444`	`+for`
	`445`	`+the`
	`446`	`+ML`
	`447`	`+engine`
	`448`	`+.`
	`449`	`+*`
`436`	`450`	`returns`
`437`	`451`	`{`
`438`	`452`	`MLEngine`
`@@ -441,15 +455,15 @@ MLEngine`
`441`	`455`	`/`
`442`	`456`	`createEngine`
`443`	`457`	`(`
`444`		`-args`
	`458`	`+options`
`445`	`459`	`)`
`446`	`460`	`{`
`447`	`461`	`return`
`448`	`462`	`lazy`
`449`	`463`	`.`
`450`	`464`	`createEngine`
`451`	`465`	`(`
`452`		`-args`
	`466`	`+options`
`453`	`467`	`)`
`454`	`468`	`;`
`455`	`469`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1655,6 +1655,13 @@ RESULT_MENU_COMMAND`
`1655`	`1655`	`name`
`1656`	`1656`	`]`
`1657`	`1657`	`*`
	`1658`	`+The`
	`1659`	`+name`
	`1660`	`+of`
	`1661`	`+the`
	`1662`	`+command`
	`1663`	`+.`
	`1664`	`+*`
`1658`	`1665`	`property`
`1659`	`1666`	`{`
`1660`	`1667`	`{`
`@@ -1667,6 +1674,19 @@ string`
`1667`	`1674`	`l10n`
`1668`	`1675`	`]`
`1669`	`1676`	`*`
	`1677`	`+The`
	`1678`	`+id`
	`1679`	`+of`
	`1680`	`+the`
	`1681`	`+l10n`
	`1682`	`+string`
	`1683`	`+to`
	`1684`	`+use`
	`1685`	`+for`
	`1686`	`+the`
	`1687`	`+translation`
	`1688`	`+.`
	`1689`	`+*`
`1670`	`1690`	`/`
`1671`	`1691`	`/`
`1672`	`1692`	`*`