Skip to content

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

Closed
@brettz9

Description

@brettz9

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.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions