mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
convert Markdown in the summary property (#1149)
This commit is contained in:
parent
5666f4ccef
commit
8ac05f56f5
@ -16,7 +16,8 @@ var defaultTags = [
|
||||
'params',
|
||||
'properties',
|
||||
'returns',
|
||||
'see'
|
||||
'see',
|
||||
'summary'
|
||||
];
|
||||
var hasOwnProp = Object.prototype.hasOwnProperty;
|
||||
var parse = require('jsdoc/util/markdown').getParser();
|
||||
|
||||
1
plugins/test/fixtures/markdown.js
vendored
1
plugins/test/fixtures/markdown.js
vendored
@ -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;
|
||||
|
||||
@ -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);
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user