-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update JSDoc and align custom JSDoc plugins #657
Conversation
… - It collided with CF docs builder logic.
@pomek Could you make a review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes are good. However, the code could be improved. Some leftover comments should be removed. Also, we're using Array.<Type>
instead of Type[]
while describing arrays.
packages/jsdoc-plugins/lib/longname-fixer/fixers/convert-short-refs-to-full-refs.js
Outdated
Show resolved
Hide resolved
packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js
Outdated
Show resolved
Hide resolved
packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js
Outdated
Show resolved
Hide resolved
packages/jsdoc-plugins/lib/relation-fixer/filteroutintenraldoclets.js
Outdated
Show resolved
Hide resolved
packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js
Outdated
Show resolved
Hide resolved
packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Kamil Piechaczek <pomek@users.noreply.github.com>
I've fixed the mentioned issues and merged master onto the PR branch. Could you do the final check @pomek? |
Suggested merge commit message (convention)
Feature (jsdoc-plugins): Updated JSDoc and align custom JSDoc plugins. Part of ckeditor/ckeditor5#7575.
.
or#
symbols. Now they are documented the same as classes, interfaces, and mixins using the~
symbol. (e.g.module:widget/utils~toWidget
),async/await
among others.MAJOR BREAKING CHANGE (jsdoc-plugins): Functions documented in a module will no longer be documented as static functions. Therefore links to functions will not contain the
static-
part and links created in the past will no longer work.Requires: