convert Markdown in the summary property (#1149)

This commit is contained in:
Jeff Williams 2017-07-10 16:31:48 -07:00
parent 5666f4ccef
commit 8ac05f56f5
3 changed files with 5 additions and 2 deletions

View File

@ -16,7 +16,8 @@ var defaultTags = [
'params',
'properties',
'returns',
'see'
'see',
'summary'
];
var hasOwnProp = Object.prototype.hasOwnProperty;
var parse = require('jsdoc/util/markdown').getParser();

View File

@ -19,6 +19,7 @@ function bar() {}
* @property {string} value - Value of myParam.
* @return {MyClass} Class instance.
* @see [Example Inc.](http://example.com)
* @summary My class.
*/
function MyClass(myParam) {
this.value = myParam;

View File

@ -24,7 +24,8 @@ describe('markdown plugin', function() {
myClass.params[0].description,
myClass.properties[0].description,
myClass.returns[0].description,
myClass.see
myClass.see,
myClass.summary
].forEach(function(value) {
// if we processed the value, it should be wrapped in a <p> tag
expect( /^<p>(?:.+)<\/p>$/.test(value) ).toBe(true);