Setting @param to single quote leads to single quotes surrounding by double

jsdoc2md / jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript

MIT License

1.69k stars 152 forks source link

Setting @param to single quote leads to single quotes surrounding by double #215

Open D-Marc1 opened 4 years ago

D-Marc1 commented 4 years ago

Might sound confusing by the title, so I'll try to explain myself. When I do @param {string} [myVar = ''], the output becomes "''". I just do a find and replace every time I make a change to the docs, but this is definitely a bug.

75lb commented 4 years ago

Do you see the same issue when generating docs with jsdoc directly?

Jsdoc2md uses jsdoc internally. If it is an issue with jsdoc, please let them know.

D-Marc1 commented 4 years ago

Just tried it and it doesn't happen on regular jsdoc. I can confirm it's an issue specific to this plugin.