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
TypeDoc should generate description for nested "options" parameter. E.g. options.first, options.second and options.third in options: { first: string, second: number, third: (a: number) => number }
Actual Behavior
Doesn't generate description for nested parameters. Only for the "options" object.
Steps to reproduce the bug
Code to document:
class Bar {
/**
* Test method with object param
* @param options Describing the options param
* @param options.first A description of the first property of the options param
*/
public fooArrow = (options: { first?: string, second: number, third: (a: number) => number }) => {
}
}
Typedoc command: typedoc --out docs index.ts
Typedoc.json:
{
"mode": "modules",
"out": "docs"
}
Should generate documentation with description of option.first nested parameter, instead generates only for options.
It works perfectly well with the function written normally, but arrow notation doesn't work. I.e.:
class Bar {
/**
* Test method with object param
* @param options Describing the options param
* @param options.first A description of the first property of the options param
*/
public fooArrow (options: { first?: string, second: number, third: (a: number) => number }) {
}
}
generates
options: object
Describing the options param
Optional first?: undefined | string
A description of the first property of the options param
while
class Bar {
/**
* Test method with object param
* @param options Describing the options param
* @param options.first A description of the first property of the options param
*/
public fooArrow = (options: { first?: string, second: number, third: (a: number) => number }) => {
}
}
Expected Behavior
TypeDoc should generate description for nested "options" parameter. E.g. options.first, options.second and options.third in
options: { first: string, second: number, third: (a: number) => number }
Actual Behavior
Doesn't generate description for nested parameters. Only for the "options" object.
Steps to reproduce the bug
Code to document:
Typedoc command:
typedoc --out docs index.ts
Typedoc.json:
Should generate documentation with description of
option.first
nested parameter, instead generates only foroptions
.It works perfectly well with the function written normally, but arrow notation doesn't work. I.e.:
generates
while
generates only
Complete sample code to reproduce the bug and sample output documentation here: https://github.com/jiri-vyc/typedoc-test
(with comparison with standard and arrow function notation)
This is afaik not a duplicate of #987 nor #497
Environment
The text was updated successfully, but these errors were encountered: