diff options
| author | toasted-nutbread <toasted-nutbread@users.noreply.github.com> | 2022-05-20 10:28:38 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-20 10:28:38 -0400 |
| commit | 31e20c889e467aa4ba64b0b5baf602adc1359371 (patch) | |
| tree | a033db935a817b2d407ec20843176610a87a6e16 /ext/js/dom/sandbox/css-style-applier.js | |
| parent | ae0ad227c0fd293609a21e5cc1d2a4b85fe7c520 (diff) | |
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
Diffstat (limited to 'ext/js/dom/sandbox/css-style-applier.js')
| -rw-r--r-- | ext/js/dom/sandbox/css-style-applier.js | 6 |
1 files changed, 4 insertions, 2 deletions
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<HTMLElement>} elements An iterable collection of HTMLElement objects. */ applyClassStyles(elements) { const elementStyles = []; |