Skip to content
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

Merged
merged 37 commits into from
Jul 21, 2020
Merged

Update JSDoc and align custom JSDoc plugins #657

merged 37 commits into from
Jul 21, 2020

Conversation

ma2ciek
Copy link
Contributor

@ma2ciek ma2ciek commented Jul 8, 2020

Suggested merge commit message (convention)

Feature (jsdoc-plugins): Updated JSDoc and align custom JSDoc plugins. Part of ckeditor/ckeditor5#7575.

  • Improved performance,
  • Fixed incorrectly and inconsistently documented functions. Previously they were marked as static/instance using the . or # symbols. Now they are documented the same as classes, interfaces, and mixins using the ~ symbol. (e.g. module:widget/utils~toWidget),
  • Validator was improved, now it detects duplicated modules and previously hidden mistakes.
  • Updated JSDoc allows for modern JS syntax, 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:

@coveralls
Copy link

coveralls commented Jul 17, 2020

Coverage Status

Coverage decreased (-0.5%) to 87.415% when pulling 5d84241 on i/7575 into f0e184d on master.

@ma2ciek
Copy link
Contributor Author

ma2ciek commented Jul 17, 2020

@pomek Could you make a review?

@ma2ciek ma2ciek marked this pull request as ready for review July 17, 2020 10:44
Copy link
Member

@pomek pomek left a 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.

@ma2ciek
Copy link
Contributor Author

ma2ciek commented Jul 21, 2020

I've fixed the mentioned issues and merged master onto the PR branch. Could you do the final check @pomek?

@ma2ciek ma2ciek requested a review from pomek July 21, 2020 08:50
@ma2ciek ma2ciek changed the title WIP Update JSDoc and align custom JSDoc plugins Update JSDoc and align custom JSDoc plugins Jul 21, 2020
@pomek pomek merged commit 755e29c into master Jul 21, 2020
@pomek pomek deleted the i/7575 branch July 21, 2020 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants