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

Print out tag name for unknown block tags #1290

Closed
wants to merge 1 commit into from

Conversation

raymondfeng
Copy link
Contributor

We ran into various cases that tsdoc comments have unknown block tags, such as:

/**
 * @decorator A new tag
 * @return A bad tag
 */

Without this PR, api-documenter just aborts with Unsupported element kind: BlockTag. The error message is meaningless and it does not help fix the underlying issue.

I would also like to know what source TS file (line/column) has the invalid tag. Please let me know how to access such metadata so that I can improve this PR.

@msftclas
Copy link

msftclas commented May 22, 2019

CLA assistant check
All CLA requirements met.

@raymondfeng
Copy link
Contributor Author

Close it as dup of #1296

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.

2 participants