Typedoc - event plugin should not guessing an event owner #853
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Suggested merge commit message (convention)
Other (typedoc-plugins): Changed the way events are defined. The value of the
@eventName
tag must be a valid identifier (link) to a class or an interface, to which given event should be attached. Closes ckeditor/ckeditor5#13553.Other (typedoc-plugins): Extended the scope of the
typedoc-plugin-event-inheritance-fixer
plugin. So far only inherited events in classes and in theObservable
interface have been checked. Now, support for inherited events has been added to all interfaces, so all derived classes and interfaces will contain all inherited events.Feature (typedoc-plugins): Added support for multiple
@eventName
tags defined for one exported type. One exported type can now be used to create multiple events, even in different (not related to each other) classes or interfaces.Internal (typedoc-plugins): Added all TypeDoc plugins (as paths to the plugin source) to the export from the package. This makes it easier to use them when creating a TypeDoc instance.
MAJOR BREAKING CHANGE (typedoc-plugins): Changed the way events are defined. Previously, the value from the
@eventName
tag was simply the name of the event and thetypedoc-plugin-tag-event
plugin was trying to guess which reflection should be the owner of this event. Now, the@eventName
value must be a valid identifier (link) to the event owner, which can be a class or an interface, to which given event will be attached. The owner of every event must be explicitly defined. The identifier can be relative or absolute.Additional information
For example – encountered issues, assumptions you had to make, other affected tickets, etc.