Promise generics show with object (dot) notation

jsdoc2md / jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript

MIT License

1.68k stars 151 forks source link

Promise generics show with object (dot) notation #276

Open jjeff opened 2 years ago

jjeff commented 2 years ago

I'm using jsdoc-to-markdown to generate the README file for electron-playwright-helpers. However the JSDoc definitions for returned Promise generics such as @returns {Promise<boolean>} leads to output which resembles this: => Promise.<boolean> note the "." before the bracket.

Is this a bug? Is there a way to remove the dot?

I've also added the @filfil and @reject values, but they're still not as clear as functionName(arg) => Promise<boolean> as a summary.

75lb commented 2 weeks ago

could you post some code and a command I can run please, so I can see and debug the issue.