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

Support class property @type tag #1028

Merged
merged 1 commit into from
Mar 8, 2018
Merged

Support class property @type tag #1028

merged 1 commit into from
Mar 8, 2018

Conversation

timdp
Copy link
Contributor

@timdp timdp commented Mar 1, 2018

This adds support for @type {SomeType} on getters and setters, similar to what JSDoc has.

This was already reported as #906.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.05%) to 86.115% when pulling a85ad7e on timdp:class-property-type-tag into 487336f on documentationjs:master.

@coveralls
Copy link

coveralls commented Mar 1, 2018

Coverage Status

Coverage decreased (-0.06%) to 86.152% when pulling 4ed90d4 on timdp:class-property-type-tag into 99ad49b on documentationjs:master.

@tmcw
Copy link
Member

tmcw commented Mar 1, 2018

Thanks, this is a positive change. Though I think it needs to implemented at a different level - this is only fixing @type tags for Markdown output, not for JSON or HTML output, because it does so in the formatter. I think implementing type handling here, in parse.js is the proper way to do this for all output mechanisms.

Copy link
Member

@tmcw tmcw left a comment

Choose a reason for hiding this comment

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

This needs to be resolved at the parsing / inference level rather than output.

@timdp
Copy link
Contributor Author

timdp commented Mar 4, 2018

Fair point. It also makes the implementation a lot easier.

I've started over and rebased on master.

@tmcw tmcw merged commit 4ed5edf into documentationjs:master Mar 8, 2018
@tmcw
Copy link
Member

tmcw commented Mar 8, 2018

Thanks!

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.

3 participants