Documentation breaks when formatting is wrong

[morkro]

Hello 👋,

it looks like the documentation is broken once a JSDoc comment has incorrect formatting.
Here are two occurrences I found:

• If you go to this part of my documentation, you see that it stops reporting in the middle of the sentence. I assume the chevron (<atom-styles>) in my description causes this problem?
  
• The documentation for my createElement() method also stops with the description, and everything after that is left blank on the page. I also guess it's because I used probably unknown formatting of an optional parameter which also happens to accept two different types: @param {(Number|String)}.
  

This makes me also think what the correct declaration of an optional parameter is, which happens to accept multiple types.

Anyway, great work! Really like this project 😀

Best,
Moritz

[lipp]

@morkro Thanks for reporting! This is an html escaping thingy. JSDoc comments are allowed to contain HTML and Markdown. So the description potentially (and intentionally) contains HTML tags in string.

Could you try to wrap your tags in backticks? This hopefully instructs JSDoc to do the right thing...

PS: Happy you like Doclets!

[morkro]

Well TIL JSDoc comments are Markdown 😁 .
Thanks for the help, I updated all my JSDoc comments and that fixed the issue. Everything looks fresh now. 👍

[lipp]

👍 Great!!! You are welcome! If you like Doclets, spread the word 😀