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.

Sign up for GitHub

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

Jump to bottom

Type tags are incorrect in JSDOC #736

Closed
matuzalemsteles opened this issue Mar 14, 2018 · 0 comments
Closed

Type tags are incorrect in JSDOC #736

matuzalemsteles opened this issue Mar 14, 2018 · 0 comments
Assignees
@matuzalemsteles
Labels
status: next-release Issues that will enter into the next release

Comments

@matuzalemsteles
Copy link
Member

When we're ready to go with the generation of API documentation, to get a better representation of what we've documented, we need to follow what's documented at http://usejsdoc.org.

See http://usejsdoc.org/tags-type.html

Expected behavior

/**
 * @type {(number|boolean)} 
 */

Current behavior

/**
 * @type {number|boolean}
 */
@matuzalemsteles matuzalemsteles self-assigned this Mar 14, 2018
matuzalemsteles added a commit to matuzalemsteles/clay that referenced this issue Mar 15, 2018
@matuzalemsteles
Fixes JSDOC on ClayCharts | Fixes liferay#736
c7f1cf3
carloslancha added a commit that referenced this issue Mar 15, 2018
@carloslancha
Merge pull request #737 from matuzalemsteles/fix-jsdoc
ff8e9dd 
Fix tag type JSDOC when use multiple types | Fixes #736
@carloslancha carloslancha added the status: next-release Issues that will enter into the next release label Mar 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matuzalemsteles matuzalemsteles

Labels
status: next-release Issues that will enter into the next release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@carloslancha @matuzalemsteles