jsdoc3/jsdoc — pull request #114 by benblank (2012-04-26 18:16:21+00:00)
Title: Markdown

This pull request is intended to provide the enhanced Markdown support requested in issue #94.

Basic features of the new Markdown plugin:

1. Will process Markdown in `@description` (both explicit and implicit), `@classdesc`, `@param`, `@property`, and `@returns` tags.
2. Additional tags (e.g. from other plugins) can be added via configuration.
3. Supports [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/).

Additionally, the default template has been tweaked to better handle paragraphs within descriptions, whether added via Markdown or explicitly by the user.

There are two major areas where improvements could be made:

1. **Multiple parsers are ugly.** It would be better to add GFM support to the "evilstreak" parser than to use the deprecated "gfm" parser, but I don't currently have enough tuits to determine whether the dialect system is flexible enough to support that, let alone implement it. If I get another block of time I can commit to it, I'll take a look.
2. **No unit tests.** I looked at the tests already included in JSDoc, but didn't see any examples of plugin testing and that portion of the documentation is a "TODO". Therefore, the plugin has only received ad-hoc testing.