search

runem / web-component-analyzer

CLI that analyzes web components and emits documentation
https://runem.github.io/web-component-analyzer
MIT License
501 stars 62 forks source link

Cannot have @ symbol in JSDoc code snippets #182

Open tpluscode opened 3 years ago

tpluscode commented 3 years ago

The JSDoc fails to parse when there is any @ in it. It simply breaks at that point and the output is only (I tried in element description) will be truncated at the first occurrence of any @

For example 

/**
 * My super element
 * 
 * Thanks to @foo
 * 
 * ## Usage
 *
 * Lorem ipsum
 */

Analysing this will result in description only as My super element\n\nThanks to

web-padawan commented 3 years ago

See #151 for a workaround.