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

[api-documenter] Using @remark inside a code block results in error #977

Open
nvh opened this issue Dec 3, 2018 · 2 comments
Open

[api-documenter] Using @remark inside a code block results in error #977

nvh opened this issue Dec 3, 2018 · 2 comments

Comments

@nvh
Copy link

nvh commented Dec 3, 2018

Using api-documenter 7.0.1
With the following comment block:

/**
 * @remark
 * Some remark
 * @public
 */
export interface Test {}

Running Api Documenter will fail with error "Error: Unsupported element kind: BlockTag"

@octogonz
Copy link
Collaborator

octogonz commented Dec 3, 2018

@nvh by design, the TSDoc tag should be called @remarks not @remark.

However, the error message here is incorrect. I'll fix that.

@nvh
Copy link
Author

nvh commented Dec 4, 2018

Ah, oops, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: AE/AD
Development

No branches or pull requests

2 participants