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
parameter, default, number constant, ellipsis
TypeDoc should describe the parameters correctly even when they are constants. For instance: "num: number = Number.MIN_SAFE_INTEGER"
TypeDoc generates the following parameter description for a constant: "num: number = ..."
/** * A small number * @param {number} [num=Number.MIN_SAFE_INTEGER] */ export function smallNumber(num=Number.MIN_SAFE_INTEGER):number { return num }
The text was updated successfully, but these errors were encountered:
See also #1552. Initializers are kind of annoying... property access might be simple enough in general that typedoc can include it.
Sorry, something went wrong.
4b927ff
No branches or pull requests
Search terms
parameter, default, number constant, ellipsis
Expected Behavior
TypeDoc should describe the parameters correctly even when they are constants.
For instance:
"num: number = Number.MIN_SAFE_INTEGER"
Actual Behavior
TypeDoc generates the following parameter description for a constant:
"num: number = ..."
Steps to reproduce the bug
Environment
The text was updated successfully, but these errors were encountered: