Skip to content

Precise validation of assorted tag type descriptions (including presence or absence) #191

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

Closed
brettz9 opened this issue Apr 7, 2019 · 1 comment

Comments

@brettz9
Copy link
Collaborator

brettz9 commented Apr 7, 2019

Issue #143 ran into a problem with parsing types within an inline comment (@link and @tutorial are the two inline comment types).

I think this demonstrates another need which is to be able to validate all the other tags, e.g., if @author is present, ensure there is some value present, preventing descriptions for items like @abstract, etc.

With a complete consideration of the inline structure across all tag descriptions, I think it will be easier to ensure that inline comments are processed and parsed as well--within the other types of tags where allowable.

I put together an initial summary at eslint/eslint#11043 when ESLint was still handling valid-jsdoc.

@brettz9
Copy link
Collaborator Author

brettz9 commented Jun 30, 2019

Handling in #233

@brettz9 brettz9 closed this as completed Jun 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants