jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard
verified publisher icon jsdoc2md

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

Open D-Marc1 opened this issue 5 years ago • 2 comments

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.

D-Marc1 avatar May 25 '20 06:05 D-Marc1

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.

75lb avatar May 25 '20 07:05 75lb

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

D-Marc1 avatar May 25 '20 18:05 D-Marc1