Content is not properly escaped #61

Closed
ErisDS opened this Issue May 5, 2014 · 0 comments

Comments

Projects
None yet
1 participant
Contributor

ErisDS commented May 5, 2014

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.

ErisDS referenced this issue in TryGhost/Ghost May 5, 2014

Closed

Proposal: Use JSDoc Code Documentation #2622

@ErisDS ErisDS added a commit to ErisDS/docker that referenced this issue May 6, 2014

@ErisDS ErisDS Escape HTML chars in types 24fb800

jbt closed this in #64 May 10, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment