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
/** * My Function. * @param topLevelCallback A top-level callback. * @param params Params object. * @param params.callback1 A callback inside an object. * @param params.testParam Some number. * @param params.callback2 A callback inside an object. */exportfunctionmyFunction(topLevelCallback: ()=>void,params: {callback1: ()=>void,testParam: number,callback2: ()=>void,},){
....}
markdown generated:
myFunction
▸ myFunction(topLevelCallback, params): void
My Function.
Parameters
Name
Type
Description
topLevelCallback
() => void
A top-level callback.
params
Object
Params object.
params.callback1
() => void
-
params.testParam
number
Some number.
params.callback2
() => void
-
Returns
void
Seems to be specific to typedoc-plugin-markdown, I've attached an image of the typedoc html results:
The text was updated successfully, but these errors were encountered:
amandaghassaei
changed the title
Missing description for functions inside object parameters
Missing description for functions inside Object parameters
Oct 18, 2022
Thanks so much for the plugin! Found an issue, thanks in advance for the help!
Related to: #281
Minimal example: https://github.com/amandaghassaei/typedoc-plugin-markdown-bug
typedoc: 0.23.16
typedoc-plugin-markdown: 3.13.6
For the function:
markdown generated:
myFunction
▸ myFunction(
topLevelCallback
,params
):void
My Function.
Parameters
topLevelCallback
void
params
Object
params.callback1
void
params.testParam
number
params.callback2
void
Returns
void
Seems to be specific to typedoc-plugin-markdown, I've attached an image of the typedoc html results:
The text was updated successfully, but these errors were encountered: