Merge pull request #251 from themoeway/dependabot/npm_and_yarn/eslint…

…-plugin-jsdoc-46.8.2

Bump eslint-plugin-jsdoc from 39.3.6 to 46.8.2

.eslintrc.json

@@ -233,7 +233,13 @@
         "no-unsanitized/property": "error",
         "jsdoc/check-access": "error",
         "jsdoc/check-alignment": "error",
-        "jsdoc/check-line-alignment": "error",
+        "jsdoc/check-line-alignment": [
+            "error",
+            "never",
+            {
+                "wrapIndent": "  "
+            }
+        ],
         "jsdoc/check-param-names": "error",
         "jsdoc/check-property-names": "error",
         "jsdoc/check-tag-names": "error",
@@ -242,10 +248,6 @@
         "jsdoc/empty-tags": "error",
         "jsdoc/implements-on-classes": "error",
         "jsdoc/multiline-blocks": "error",
-        "jsdoc/newline-after-description": [
-            "error",
-            "never"
-        ],
         "jsdoc/no-bad-blocks": "error",
         "jsdoc/no-multi-asterisks": "error",
         "jsdoc/require-asterisk-prefix": "error",

ext/js/app/popup-factory.js

@@ -71,6 +71,7 @@ class PopupFactory {
      * @param {?number} [details.depth] A specific depth value to assign to the popup.
      * @param {boolean} [details.popupWindow] Whether or not a separate popup window should be used, rather than an iframe.
      * @param {boolean} [details.childrenSupported] Whether or not the popup is able to show child popups.
+     * @returns {Popup|PopupWindow|PopupProxy} The new or existing popup.
      */
     async getOrCreatePopup({
         frameId=null,

ext/js/core.js

@@ -309,7 +309,7 @@ function promiseTimeout(delay, resolveValue) {
  * Creates a promise that will resolve after the next animation frame, using `requestAnimationFrame`.
  * @param {number} [timeout] A maximum duration (in milliseconds) to wait until the promise resolves. If null or omitted, no timeout is used.
  * @returns {Promise<{time: number, timeout: number}>} A promise that is resolved with `{time, timeout}`, where `time` is the timestamp from `requestAnimationFrame`,
- *  and `timeout` is a boolean indicating whether the cause was a timeout or not.
+ *   and `timeout` is a boolean indicating whether the cause was a timeout or not.
  * @throws The promise throws an error if animation is not supported in this context, such as in a service worker.
  */
 function promiseAnimationFrame(timeout=null) {
@@ -609,7 +609,7 @@ class DynamicProperty extends EventDispatcher {
      * @param {*} value The override value to assign.
      * @param {number} [priority] The priority value to use, as a number.
      * @returns {string} A string token which can be passed to the clearOverride function
-     *  to remove the override.
+     *   to remove the override.
      */
     setOverride(value, priority=0) {
         const overridesCount = this._overrides.length;

ext/js/dom/dom-text-scanner.js

@@ -405,8 +405,8 @@ class DOMTextScanner {
      * @returns {{enterable: boolean, newlines: number}} The seek information.
      *   The `enterable` value indicates whether the content of this node should be entered.
      *   The `newlines` value corresponds to the number of newline characters that should be added.
-     *     1 newline corresponds to a simple new line in the layout.
-     *     2 newlines corresponds to a significant visual distinction since the previous content.
+     *   - 1 newline corresponds to a simple new line in the layout.
+     *   - 2 newlines corresponds to a significant visual distinction since the previous content.
      */
     static getElementSeekInfo(element) {
         let enterable = true;

ext/js/dom/sandbox/css-style-applier.js

@@ -35,9 +35,10 @@ class CssStyleApplier {
      * @property {string} value The property's value.
      */
 
+    /* eslint-disable jsdoc/check-line-alignment */
     /**
      * Creates a new instance of the class.
-     * @param {string} styleDataUrl The local URL to the JSON file continaing the style rules.
+     * @param {string} styleDataUrl The local URL to the JSON file containing the style rules.
      *   The style rules should be of the format:
      *   ```
      *   [
@@ -57,6 +58,7 @@ class CssStyleApplier {
         this._patternHtmlWhitespace = /[\t\r\n\f ]+/g;
         this._patternClassNameCharacter = /[0-9a-zA-Z-_]/;
     }
+    /* eslint-enable jsdoc/check-line-alignment */
 
     /**
      * Loads the data file for use.

package.json

@@ -41,7 +41,7 @@
         "css": "^3.0.0",
         "eslint": "^8.50.0",
         "eslint-plugin-header": "^3.1.1",
-        "eslint-plugin-jsdoc": "^39.3.6",
+        "eslint-plugin-jsdoc": "^46.8.2",
         "eslint-plugin-jsonc": "^2.9.0",
         "eslint-plugin-no-unsanitized": "^4.0.1",
         "fake-indexeddb": "^4.0.2",