ckeditor5 icon indicating copy to clipboard operation
ckeditor5 copied to clipboard

`MouseEvent` is not allowed as a param type in docs

Open Dumluregn opened this issue 3 years ago • 1 comments

📝 Provide detailed reproduction steps (if any)

  1. Set a param type of MouseEvent in API docs.
  2. Run yarn run docs.
  3. See the log.

✔️ Expected result

Parameter is consumed by JSDoc.

❌ Actual result

It is thrown as an incorrect type:

$ yarn run docs
yarn run v1.22.15
$ node --max-old-space-size=8192 ./scripts/docs/build-docs.js
JSDoc started...
Incorrect param type: MouseEvent

See https://github.com/ckeditor/ckeditor5/pull/12080#discussion_r940199925 for details.

Dumluregn avatar Aug 08 '22 14:08 Dumluregn

Probably it is enough to add the MouseEvent type in https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/jsdoc-plugins/lib/validator/types.js.

pomek avatar Aug 09 '22 08:08 pomek

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

CKEditorBot avatar Sep 30 '23 05:09 CKEditorBot

We've closed your issue due to inactivity over the last year. We understand that the issue may still be relevant. If so, feel free to open a new one (and link this issue to it).

CKEditorBot avatar Oct 31 '23 05:10 CKEditorBot