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

Upgrade jsdoc(api) and fix tests #103

Merged
merged 1 commit into from
Sep 15, 2019
Merged

Upgrade jsdoc(api) and fix tests #103

merged 1 commit into from
Sep 15, 2019

Conversation

zachasme
Copy link
Contributor

@zachasme zachasme commented Sep 13, 2019

Resolves #101.

There was an issue with type applications in Node 12 which was fixed in this commit to jsdoc.

This PR upgrades jsdoc and jsdoc-api. However, this jsdoc upgrade introduces some changes to the output:

  • Most of the Closure Compiler tags were added to the list of definitions at some point, but in such a way that the are ignored. I've added a simple plugin which adds @template to the list of tags in jsdoc output. This means users need to use a similar plugin to achieve @template support. There might a better solution.
  • Classes and constructors are being merged in strange ways and @class tags without a name results in the class being considered undocumented which in turn means it gets deleted due to data({ undocumented: true }).remove(); in publish.ts. I've added names to fixtures and expected to avoid the problem, but it would be preferable to find a better solution.
  • Probably related to the previous point, private constructors meant the class became undocumented, so I've changed the test using @private to @hideconstructor.

Most of these should probably be brought up as issues in jsdoc.

dictionary.defineTag("template", {
onTagged: function(doclet, tag) {
doclet.tags = doclet.tags || [];
doclet.tags.push(tag);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the real fix here is to use the new output jsdoc produces for @template rather than hack it back into the "unknown tags" list.

Copy link
Owner

@englercj englercj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. Let's address removing the plugin in a different PR.

@englercj englercj merged commit 8e8612c into englercj:master Sep 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tests failing
2 participants