We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
I would expect unknown @-annotations to show up in the documentation the way they do for other types, like so:
This is particularly useful for writing annotations that are meant to be compatible with TSDoc, like @example.
@example
If I write an unknown @-annotation on a type alias whose value is a function:
/** * @asdf Some example text */ export type Foo = (arg: string) => string;
It doesn't appear in the output:
Just run npx typedoc test.ts on the above code.
npx typedoc test.ts
The text was updated successfully, but these errors were encountered:
Oops... that's an easy fix at least. Apparently I didn't realize that Comment always has the tags property, even if there are no tags.
Comment
tags
Sorry, something went wrong.
0d04c08
No branches or pull requests
Expected Behavior
I would expect unknown @-annotations to show up in the documentation the way they do for other types, like so:
This is particularly useful for writing annotations that are meant to be compatible with TSDoc, like
@example
.Actual Behavior
If I write an unknown @-annotation on a type alias whose value is a function:
It doesn't appear in the output:
Steps to reproduce the bug
Just run
npx typedoc test.ts
on the above code.Environment
The text was updated successfully, but these errors were encountered: