From 31e20c889e467aa4ba64b0b5baf602adc1359371 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Fri, 20 May 2022 10:28:38 -0400 Subject: ESlint JSdoc (#2148) * Install eslint-plugin-jsdoc * Initial rules setup * Update lists * Use @returns rather than @return * Remove error throwing code which is never executed * Fix issues relating to @throws * General error fixes * Update Display type documentation * Various doc fixes * Fix invalid tuple syntax * Doc updates * Remove unused * Doc updates * Enable jsdoc/require-returns * Update rules * Update remaining rules --- ext/js/dom/sandbox/css-style-applier.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'ext/js/dom/sandbox') diff --git a/ext/js/dom/sandbox/css-style-applier.js b/ext/js/dom/sandbox/css-style-applier.js index a6938d92..6c45f13e 100644 --- a/ext/js/dom/sandbox/css-style-applier.js +++ b/ext/js/dom/sandbox/css-style-applier.js @@ -36,8 +36,9 @@ class CssStyleApplier { /** * Creates a new instance of the class. - * @param styleDataUrl The local URL to the JSON file continaing the style rules. + * @param {string} styleDataUrl The local URL to the JSON file continaing the style rules. * The style rules should be of the format: + * ``` * [ * { * selectors: [(selector:string)...], @@ -46,6 +47,7 @@ class CssStyleApplier { * ] * }... * ] + * ``` */ constructor(styleDataUrl) { this._styleDataUrl = styleDataUrl; @@ -84,7 +86,7 @@ class CssStyleApplier { /** * Applies CSS styles directly to the "style" attribute using the "class" attribute. * This only works for elements with a single class. - * @param elements An iterable collection of HTMLElement objects. + * @param {Iterable} elements An iterable collection of HTMLElement objects. */ applyClassStyles(elements) { const elementStyles = []; -- cgit v1.2.3