From 43371dd5d2b7c3586e5f41bc30c9cd21bb000d5f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 24 Dec 2021 07:26:42 -0800 Subject: [PATCH 1/2] events: clarify JSDoc entries Split the JSDoc entries into separate blocks. This is in preparation for enabling jsdoc/check-param-names lint rule. PR-URL: https://github.com/nodejs/node/pull/41311 Reviewed-By: Antoine du Hamel Reviewed-By: Luigi Pinca --- lib/internal/event_target.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/internal/event_target.js b/lib/internal/event_target.js index 83908e66bfc48d..3bc2fbb81cb20c 100644 --- a/lib/internal/event_target.js +++ b/lib/internal/event_target.js @@ -443,7 +443,13 @@ class EventTarget { /** * @callback EventTargetCallback * @param {Event} event + */ + + /** * @typedef {{ handleEvent: EventTargetCallback }} EventListener + */ + + /** * @param {string} type * @param {EventTargetCallback|EventListener} listener * @param {{ From f81c62704fc4e3e0eb1b1c813854ad52fbb8fe75 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 24 Dec 2021 07:29:30 -0800 Subject: [PATCH 2/2] tools: enable jsdoc/check-param-names lint rule PR-URL: https://github.com/nodejs/node/pull/41311 Reviewed-By: Antoine du Hamel Reviewed-By: Luigi Pinca --- .eslintrc.js | 1 - 1 file changed, 1 deletion(-) diff --git a/.eslintrc.js b/.eslintrc.js index 9ab6638b10e4af..b630e21b5565d1 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -350,7 +350,6 @@ module.exports = { 'jsdoc/check-tag-names': 'off', 'jsdoc/require-returns': 'off', 'jsdoc/require-property-description': 'off', - 'jsdoc/check-param-names': 'off', // Custom rules from eslint-plugin-node-core 'node-core/no-unescaped-regexp-dot': 'error',