You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, TypeDoc does not support bracketed defaults for @param tag. It simply ignores everything after the first @param tag.
(Brackets are used by JSDoc to signify defaults, see: https://devhints.io/jsdoc)
/**
* This is the init function.
* @param args The init args.
* - `args.foo` This defaults to 'bar'.
*/
public init(args: FooInitArgs): void { }
The text was updated successfully, but these errors were encountered:
We need to figure out a way to document object-type parameters' default values:
Related TypeDoc issue(s):
TypeStrong/typedoc#567
Currently, TypeDoc does not support bracketed defaults for
@param
tag. It simply ignores everything after the first@param
tag.(Brackets are used by JSDoc to signify defaults, see: https://devhints.io/jsdoc)
The text was updated successfully, but these errors were encountered: