API docs builder should allow to override EventInfo with other class

[niegowski]

Provide a description of the task

This is a follow-up for #9023 where we introduced BubblingEventInfo but there is no way to alter the API docs to inform about this class used instead of EventInfo while describing an event.

📃 Other details

• Browser: …
• OS: …
• CKEditor version: …
• Installed CKEditor plugins: …

[niegowski]

Seems that https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/jsdoc-plugins/lib/event-extender/event-extender.js#L25-L33 should extend the params list only if the first param name is not eventInfo.

[ma2ciek]

Seems that https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/jsdoc-plugins/lib/event-extender/event-extender.js#L25-L33 should extend the params list only if the first param name is not eventInfo.

Actually, I feel that all our events should declare all arguments on which the callback is called. But this is probably undoable as there are observables and other weird CKEditor 5 constructs 😄

@event foo
@param {BubblingEventInfo} eventInfo
@param {*} data

@event bar
@param {EventInfo} eventInfo
@param {*} data

So perhaps we can implement it as you suggested.

[CKEditorBot]

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 still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

[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).