diff --git a/.eslintrc.json b/.eslintrc.json index 8a76938ea..718807ab9 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -34,7 +34,7 @@ }, "ignore": ["constructor"] }], - "valid-jsdoc": ["error", { + "valid-jsdoc": ["warn", { "prefer": { "arg": "param", "argument": "param", diff --git a/src/components/PasswordBox.js b/src/components/PasswordBox.js index 11bd18063..ea99da111 100644 --- a/src/components/PasswordBox.js +++ b/src/components/PasswordBox.js @@ -17,7 +17,6 @@ */ class PasswordBox extends Observable { - // eslint-disable-next-line valid-jsdoc /** * @param {?HTMLFormElement} [$el] * @param {Partial} [options] diff --git a/src/components/PasswordSetterBox.js b/src/components/PasswordSetterBox.js index 4bdce25d5..ed542ae77 100644 --- a/src/components/PasswordSetterBox.js +++ b/src/components/PasswordSetterBox.js @@ -6,7 +6,6 @@ /* global TemplateTags */ class PasswordSetterBox extends Observable { - // eslint-disable-next-line valid-jsdoc /** * @param {?HTMLFormElement} [$el] * @param {{bgColor?: string, buttonI18nTag?: string}} [options] diff --git a/src/components/QrVideoScanner.js b/src/components/QrVideoScanner.js index 4b2c60469..071118a84 100644 --- a/src/components/QrVideoScanner.js +++ b/src/components/QrVideoScanner.js @@ -4,7 +4,6 @@ /* global TemplateTags */ class QrVideoScanner extends Observable { - // eslint-disable-next-line valid-jsdoc /** * @param {?HTMLDivElement} [$el] * @param {(result: string) => boolean} [validator] diff --git a/src/lib/CookieStorage.js b/src/lib/CookieStorage.js index 8175cd111..d0a0a4cac 100644 --- a/src/lib/CookieStorage.js +++ b/src/lib/CookieStorage.js @@ -116,7 +116,6 @@ class CookieStorage { return !!CookieJar.readCookie(this._getChunkCookieName(name, 0, namespace)); } - // eslint-disable-next-line valid-jsdoc /** * @param {string} name * @param {Uint8Array} data diff --git a/src/lib/FiatApi.js b/src/lib/FiatApi.js index 1d442d2c0..5ac3bc453 100644 --- a/src/lib/FiatApi.js +++ b/src/lib/FiatApi.js @@ -1,7 +1,6 @@ // Adapted and reduced version of FiatApi.ts from @nimiq/utils // This file should also be updated whenever FiatApi.ts in @nimiq/utils is updated. class FiatApi { - // eslint-disable-next-line valid-jsdoc /** * @param {Array} cryptoCurrencies * @param {Array} vsCurrencies diff --git a/src/lib/I18n.js b/src/lib/I18n.js index 174d2b261..1704c7faf 100644 --- a/src/lib/I18n.js +++ b/src/lib/I18n.js @@ -58,7 +58,6 @@ class I18n { // eslint-disable-line no-unused-vars static translateDom(dom = document.body, enforcedLanguage) { const language = enforcedLanguage ? this.getClosestSupportedLanguage(enforcedLanguage) : this.language; - /* eslint-disable-next-line valid-jsdoc */ // Multi-line descriptions are not valid JSDoc, apparently /** * @param {string} tag * @param {(element: HTMLElement, translation: string) => void} callback - callback(element, translation) for diff --git a/src/lib/JsonUtils.js b/src/lib/JsonUtils.js index a0cf6eb11..d34a9b443 100644 --- a/src/lib/JsonUtils.js +++ b/src/lib/JsonUtils.js @@ -53,7 +53,6 @@ class JsonUtils { return value; } - /* eslint-disable-next-line valid-jsdoc */ /** * @param {number} type * @param {string} value diff --git a/src/lib/Key.js b/src/lib/Key.js index bf6bd158c..28a4a45ac 100644 --- a/src/lib/Key.js +++ b/src/lib/Key.js @@ -145,7 +145,6 @@ class Key { return Key.deriveHash(input); } - // eslint-disable-next-line valid-jsdoc /** * @param {unknown} other * @returns {other is Key} diff --git a/src/lib/KeyInfo.js b/src/lib/KeyInfo.js index 40ffd59c4..d93362294 100644 --- a/src/lib/KeyInfo.js +++ b/src/lib/KeyInfo.js @@ -85,7 +85,6 @@ class KeyInfo { return new KeyInfo(obj.id, obj.type, encrypted, obj.hasPin, defaultAddress); } - // eslint-disable-next-line valid-jsdoc /** * @param {unknown} other * @returns {other is KeyInfo} diff --git a/src/lib/Observable.js b/src/lib/Observable.js index d2d942c5f..8b80cb9f3 100644 --- a/src/lib/Observable.js +++ b/src/lib/Observable.js @@ -16,7 +16,6 @@ class Observable { // eslint-disable-line no-unused-vars this._listeners = new Map(); } - // eslint-disable-next-line valid-jsdoc /** * @param {string} type * @param {(...arg: any[]) => any} callback diff --git a/src/lib/QrScanner.js b/src/lib/QrScanner.js index 4f4f2a648..0f109e698 100644 --- a/src/lib/QrScanner.js +++ b/src/lib/QrScanner.js @@ -29,7 +29,6 @@ class QrScanner { } } - // eslint-disable-next-line valid-jsdoc /** * @param {HTMLVideoElement} video * @param {(result: string) => any} onDecode diff --git a/src/lib/RequestParser.js b/src/lib/RequestParser.js index 1aa34537e..463a2cc09 100644 --- a/src/lib/RequestParser.js +++ b/src/lib/RequestParser.js @@ -217,7 +217,6 @@ class RequestParser { // eslint-disable-line no-unused-vars } } - // eslint-disable-next-line valid-jsdoc /** * @template {boolean} T * @param {any} address diff --git a/src/lib/TemplateTags.js b/src/lib/TemplateTags.js index 308e3954e..fce5f3adb 100644 --- a/src/lib/TemplateTags.js +++ b/src/lib/TemplateTags.js @@ -1,6 +1,5 @@ class TemplateTags { // Let typescript infer return value. (Seems to be impossible to declare it the right way in standard JSDoc) - // eslint-disable-next-line valid-jsdoc /** * @template {number} T * @param {T} variableCount diff --git a/src/lib/bitcoin/BitcoinRequestParserMixin.js b/src/lib/bitcoin/BitcoinRequestParserMixin.js index db2d19e3f..3e2daea6f 100644 --- a/src/lib/bitcoin/BitcoinRequestParserMixin.js +++ b/src/lib/bitcoin/BitcoinRequestParserMixin.js @@ -8,7 +8,6 @@ * @typedef {new (...args: any[]) => T} BitcoinRequestParserMixinConstructor; */ -// eslint-disable-next-line valid-jsdoc /** * A mixin to add Bitcoin-related request parsers to a RequestParser class. * diff --git a/src/lib/polygon/PolygonRequestParserMixin.js b/src/lib/polygon/PolygonRequestParserMixin.js index 35de47489..456092a14 100644 --- a/src/lib/polygon/PolygonRequestParserMixin.js +++ b/src/lib/polygon/PolygonRequestParserMixin.js @@ -7,7 +7,6 @@ * @typedef {new (...args: any[]) => T} PolygonRequestParserMixinConstructor; */ -// eslint-disable-next-line valid-jsdoc /** * A mixin to add Polygon-related request parsers to a RequestParser class. * diff --git a/src/request/sign-polygon-transaction/SignPolygonTransactionApi.js b/src/request/sign-polygon-transaction/SignPolygonTransactionApi.js index 7cbe052cc..8874d7e8d 100644 --- a/src/request/sign-polygon-transaction/SignPolygonTransactionApi.js +++ b/src/request/sign-polygon-transaction/SignPolygonTransactionApi.js @@ -54,7 +54,6 @@ class SignPolygonTransactionApi extends PolygonRequestParserMixin(TopLevelApi) { return parsedRequest; } - // eslint-disable-next-line valid-jsdoc /** * * @param {KeyguardRequest.PolygonTransactionInfo} request diff --git a/src/request/sign-swap/SignSwapApi.js b/src/request/sign-swap/SignSwapApi.js index 3b7cdb478..7da987bbb 100644 --- a/src/request/sign-swap/SignSwapApi.js +++ b/src/request/sign-swap/SignSwapApi.js @@ -330,7 +330,6 @@ class SignSwapApi extends PolygonRequestParserMixin(BitcoinRequestParserMixin(To return direction; } - // eslint-disable-next-line valid-jsdoc /** * * @param {Omit} request