jbt / docker

Documentation generator
http://jbt.github.com/docker
MIT License
233 stars 56 forks source link

Content is not properly escaped #61

Closed ErisDS closed 10 years ago

ErisDS commented 10 years ago

Things that look like HTML tags disappear from the output because they get rendered as part of the DOM.

For a reasonably sane example:

/**
 * ## My Function
 * Description
 * @return {Promise<String>}
 */

The <String> part disappears whereas I would expect it to be output as text.

This is the same regardless of whether it is in a title, description, tag name, tag type, tag description etc. Not sure if it should be escaped for anything other than the tag type, but this sort of formatting is reasonably common I think.