Method description not shown when methods use arrows
xixixao opened this issue · 9 comments
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
Works:
export type SomeType = {
/**
* METHOD DESCRIPTION
*
* @returns RETURN DESCRIPTION
*/
signIn(): string;
};
Doesn't work:
export type SomeType = {
/**
* METHOD DESCRIPTION
*
* @returns RETURN DESCRIPTION
*/
signIn: () => string;
};
In my case I don't need the arrow syntax, so I have a workaround, but it seems like a bug.
I verified this is a bug in this plugin and not in typedoc.
TypeDoc configuration
Latest everything.
npx typedoc --plugin typedoc-plugin-markdown --entryPoints foo.ts --out ./docs
Expected behavior
No response
Also btw it might be nice to give ppl some online playground (codepen or something) for easily sharing repros of issues.
Actually I can't use the workaround, because that breaks type lints that check whether a method is bound or not.
Fix in typedoc-plugin-markdown@4.2.5 .
Also btw it might be nice to give ppl some online playground (codepen or something) for easily sharing repros of issues.
Thanks - yes that is not a bad idea.
@Artemeey thanks - this is now fixed in typedoc-plugin-markdown@4.2.6
It's work!
But not all of them, example:
/**
* Info
*/
export const exampleWork = (): void => { }; // exists description in index
/**
* Info
* @return info
*/
export const exampleNoWork = (): void => { }; // no exists description in index
But not all of them, example:
Ah - you are right - thanks. Will be fixed in next release.