Output raw @description
Closed this issue · 0 comments
tomek-he-him commented
According to jsDoc these are equivalent:
/**
* Short summary
*
* Chatty description.
*/
/**
* @description
* Short summary
*
* Chatty description.
*/
Why not make the output equivalent? Like:
[
{
"tags": [
{
"type": "description",
"string": "Short summary\n\nChatty description.\n"
}
],
"description": {
"full": "<p>Short summary</p><p>Chatty description.</p>",
"summary": "<p>Short summary</p>",
"body": "<p>Chatty description.</p>"
},
// ...
}
]
Sometimes you just want the raw description, not parsed by markdown.
Concrete use case: we want to display a list of docblocks with the summary in the tooltip. The title
attribute doesn't want any HTML tags. It seems wrong to “demarkdown” HTML for that.