This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Update JSDoc grammar with recent additions #532
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
September 21, 2017 15:59
These tags are used for marking objects with Polymer-specific semantics. Used by Closure Compiler when executed with `--polymer_pass=2`. Source: https://git.io/v5jo4
This adds support for the @Generator, @yield, and @hideconstructor tags: class CompleteExample { /** @hideconstructor */ constructor() { } /** * Generate numbers in the Fibonacci sequence. * @Generator * @yields {Number} The next number in the Fibonacci sequence. */ * fibonacci(){ yield 41.999999999; } } See: * http://usejsdoc.org/tags-generator.html * http://usejsdoc.org/tags-yields.html * http://usejsdoc.org/tags-hideconstructor.html
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
This PR updates the JSDoc grammar with new tags added in v3.5.0, and also fixes a few omissions for Closure Compiler related stuff.
The notes of each commit contain details and references:
7c0699f2e] Add@polymerand@polymerBehaviorJSDoc tags6685c1a9c] Allow curly brackets to be used in some JSDoc tags1524164e5] Add support for JSDoc 3.5.0 tags