Skip to content
New issue

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

Missing description for functions inside Object parameters #357

Closed
amandaghassaei opened this issue Oct 12, 2022 · 3 comments
Closed

Missing description for functions inside Object parameters #357

amandaghassaei opened this issue Oct 12, 2022 · 3 comments

Comments

@amandaghassaei
Copy link

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:

/**
 * 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.
 */
export function myFunction(
  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:
Screen Shot 2022-10-12 at 3 32 53 PM

@amandaghassaei amandaghassaei changed the title Missing description for functions inside object parameters Missing description for functions inside Object parameters Oct 18, 2022
@tgreyuk
Copy link
Member

tgreyuk commented Dec 2, 2022

Fix in typedoc-plugin-markdown@3.14.0

@tgreyuk tgreyuk closed this as completed Dec 2, 2022
@amandaghassaei
Copy link
Author

Looks great, thanks for your help!

@tgreyuk
Copy link
Member

tgreyuk commented Dec 2, 2022

No problem - apologies it took so long :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants