commit ba4a7c544459448183778e32030fb812d80a8bc6
parent f105a98c8da0241d1c4d5965b0b8de7e402deb8c
Author: Mark Banner <standard8@mozilla.com>
Date: Mon, 3 Nov 2025 12:15:04 +0000
Bug 1997357 - Fix instances of invalid inline JSDoc tags. r=Sasha
@code and @see are not valid inline tags for JSDoc, we need to replace them with the code markdown, and @link.
Differential Revision: https://phabricator.services.mozilla.com/D270685
Diffstat:
4 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/remote/marionette/server.sys.mjs b/remote/marionette/server.sys.mjs
@@ -398,7 +398,7 @@ export class TCPConnection {
}
/**
- * Delegates message to client based on the provided {@code cmdID}.
+ * Delegates message to client based on the provided `cmdID`.
* The message is sent over the debugger transport socket.
*
* The command ID is a unique identifier assigned to the client's request
diff --git a/remote/shared/webdriver/Accessibility.sys.mjs b/remote/shared/webdriver/Accessibility.sys.mjs
@@ -81,7 +81,7 @@ accessibility.ActionableRoles = new Set([
]);
/**
- * Factory function that constructs a new {@code accessibility.Checks}
+ * Factory function that constructs a new `accessibility.Checks`
* object with enforced strictness or not.
*/
accessibility.get = function (strict = false) {
@@ -289,13 +289,13 @@ accessibility.Checks = class {
}
/**
- * Test if an accessible has a {@code hidden} attribute.
+ * Test if an accessible has a `hidden` attribute.
*
* @param {nsIAccessible} accessible
* Accessible object.
*
* @returns {boolean}
- * True if the accessible object has a {@code hidden} attribute,
+ * True if the accessible object has a `hidden` attribute,
* false otherwise.
*/
hasHiddenAttribute(accessible) {
diff --git a/toolkit/components/extensions/Schemas.sys.mjs b/toolkit/components/extensions/Schemas.sys.mjs
@@ -708,7 +708,7 @@ class Context {
/**
* Executes the given callback, and returns an array of choice strings
- * passed to {@see #error} during its execution.
+ * passed to {@link #error} during its execution.
*
* @param {Function} callback
* @returns {object}
diff --git a/toolkit/components/extensions/test/xpcshell/test_ext_contentscript_triggeringPrincipal.js b/toolkit/components/extensions/test/xpcshell/test_ext_contentscript_triggeringPrincipal.js
@@ -183,7 +183,7 @@ function getElementData(test, opts) {
}
/**
- * The result type of the {@see createElement} function.
+ * The result type of the {@link createElement} function.
*
* @typedef {object} CreateElementResult
* @property {Element} elem
@@ -197,7 +197,7 @@ function getElementData(test, opts) {
/**
* Creates a DOM tree for a given test, in a given configuration, as
- * understood by {@see getElementData}, but without the `test.srcAttr`
+ * understood by {@link getElementData}, but without the `test.srcAttr`
* attribute having been set. The caller must set the value of that
* attribute to the returned `src` value.
*
@@ -207,9 +207,9 @@ function getElementData(test, opts) {
* many variants of these as possible.
*
* @param {ElementTestCase} test
- * A test object, as passed to {@see getElementData}.
+ * A test object, as passed to {@link getElementData}.
* @param {ElementTestOptions} opts
- * An options object, as passed to {@see getElementData}.
+ * An options object, as passed to {@link getElementData}.
* @returns {CreateElementResult}
*/
function createElement(test, opts) {
@@ -281,13 +281,13 @@ function escaped(strings, ...values) {
}
/**
- * Converts the given test data, as accepted by {@see getElementData},
+ * Converts the given test data, as accepted by {@link getElementData},
* to an HTML representation.
*
* @param {ElementTestCase} test
- * A test object, as passed to {@see getElementData}.
+ * A test object, as passed to {@link getElementData}.
* @param {ElementTestOptions} opts
- * An options object, as passed to {@see getElementData}.
+ * An options object, as passed to {@link getElementData}.
* @returns {string}
*/
function toHTML(test, opts) {
@@ -586,9 +586,9 @@ function testInlineCSS() {
* various configurations.
*
* @param {Array<ElementTestCase>} tests
- * A list of test objects, as understood by {@see getElementData}.
+ * A list of test objects, as understood by {@link getElementData}.
* @param {ElementTestOptions} baseOpts
- * A base options object, as understood by {@see getElementData},
+ * A base options object, as understood by {@link getElementData},
* which represents the default values for injections under this
* context.
*/
@@ -758,13 +758,13 @@ function injectElements(tests, baseOpts) {
}
/**
- * Stringifies the {@see injectElements} function for use as a page or
+ * Stringifies the {@link injectElements} function for use as a page or
* content script.
*
* @param {Array<ElementTestCase>} tests
- * A list of test objects, as understood by {@see getElementData}.
+ * A list of test objects, as understood by {@link getElementData}.
* @param {ElementTestOptions} opts
- * A base options object, as understood by {@see getElementData},
+ * A base options object, as understood by {@link getElementData},
* which represents the default values for injections under this
* context.
* @returns {string}
@@ -822,7 +822,7 @@ function getOriginBase(origURL) {
* with the `origin` query parameter removed.
*
* @param {Array<ElementTestCase>} tests
- * A list of tests, as understood by {@see getElementData}.
+ * A list of tests, as understood by {@link getElementData}.
* @param {Record<string, object>} expectedSources
* A set of sources for which each of the above tests is expected
* to generate one request, if each of the properties in the
@@ -946,7 +946,7 @@ function computeExpectedForbiddenURLs(
*
* @param {Promise<object>} urlsPromise
* A promise which resolves to an object containing expected and
- * forbidden URL sets, as returned by {@see computeBaseURLs}.
+ * forbidden URL sets, as returned by {@link computeBaseURLs}.
* @param {Record<string, string>} origins
* A mapping of origin parameters as they appear in URL query
* strings to the origin strings returned by corresponding
@@ -1015,7 +1015,7 @@ function awaitLoads(urlsPromise, origins) {
*
* @param {Promise<object>} urlsPromise
* A promise which resolves to an object containing expected and
- * forbidden URL sets, as returned by {@see computeBaseURLs}.
+ * forbidden URL sets, as returned by {@link computeBaseURLs}.
* @param {ExtensionWrapper} extension
* @returns {Promise}
* A promise which resolves when all requests have been
@@ -1087,7 +1087,7 @@ function awaitCSP(urlsPromise, extension) {
/**
* A list of tests to run in each context, as understood by
- * {@see getElementData}.
+ * {@link getElementData}.
*/
const TESTS = [
{
