Param object trans head not ok
Closed this issue · 2 comments
jiawei397 commented
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
This is the test.ts
code:
/**
* The application constructor.
* @param param - The initial parameters.
* @param param.container - The dom element to render scene.
* @param param.background? - The background.
*/
class App {
constructor(param: {
container: HTMLElement;
background?: number | string | Number[];
}) {}
}
Now the param not ok:
# Class: App
The application constructor.
## Param
The initial parameters.
## Param
The dom element to render scene.
## Param
The background.
TypeDoc configuration
{
"$schema": "https://typedoc.org/schema.json",
"plugin": ["typedoc-plugin-markdown"],
"entryPoints": ["./*.ts"],
"out": "./docs"
}
Expected behavior
# Class: App
The application constructor.
## Param: param
The initial parameters.
## Param: param.container
The dom element to render scene.
## Param: param.background
The background.
tgreyuk commented
jiawei397 commented