archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

cleanup

Browse Source
This commit is contained in:
Jeff Williams 2013-10-31 15:32:08 -07:00
parent e17b785a43
commit 7ac6bfee1c
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
plugins/markdown.js
View File

@ -12,6 +12,20 @@ var parse = require('jsdoc/util/markdown').getParser();
var tags = []; var tags = [];
var excludeTags = []; var excludeTags = [];
function shouldProcessString(tagName, text) {
var shouldProcess = false;
if (tagName !== 'see') {
shouldProcess = true;
}
// we only want to process `@see` tags that contain Markdown links
else if (tagName === 'see' && text.indexOf('[') !== -1) {
shouldProcess = true;
}
return shouldProcess;
}
/** /**
* Process the markdown source in a doclet. The properties that should be * Process the markdown source in a doclet. The properties that should be
* processed are configurable, but always include "classdesc", "description", * processed are configurable, but always include "classdesc", "description",
@ -24,13 +38,10 @@ function process(doclet) {
return; return;
} }
if (typeof doclet[tag] === "string" && if (typeof doclet[tag] === "string" && shouldProcessString(tag, doclet[tag]) ) {
(tag != 'see' ||
// treat '@see' specially, since we only want to process @see text that contains links
(tag == 'see' && doclet[tag].indexOf('[') != -1))) {
doclet[tag] = parse(doclet[tag]); doclet[tag] = parse(doclet[tag]);
} }
else if (doclet[tag] instanceof Array) { else if ( Array.isArray(doclet[tag]) ) {
doclet[tag].forEach(function(value, index, original) { doclet[tag].forEach(function(value, index, original) {
var inner = {}; var inner = {};
inner[tag] = value; inner[tag] = value;