Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output raw @description #158

Closed
tomek-he-him opened this issue Mar 9, 2015 · 0 comments
Closed

Output raw @description #158

tomek-he-him opened this issue Mar 9, 2015 · 0 comments

Comments

@tomek-he-him
Copy link
Contributor

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.

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

No branches or pull requests

2 participants