Fix @abstract and @module annotations #9563
Merged
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.
When there is a description below an
@abstracttag, JSDoc emits warnings like this:(The things that are frustrating about this are the lack of path, the wrong line numbers, and the repetition. Perhaps the repetition and wrong line numbers are due to us manipulating the file in a plugin.)
In the case above, the
@abstracttag is not parsed (not available to a plugin that might want to do something with it) and the description is lost. When the description is placed above the@abstractannotation, things are properly parsed.Similar situation with
@module. But no warning here. When there is a description below a@moduletag, the doclet's longname includes the description.When the description is below, the doclet includes this:
When the description is above, the longname is properly set to "module:ol/worker/version".