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

Merge pull request #360 from Billiam/fix/markdown-exclude-tags-337

Browse Source 
Add excludeTags config option for markdown plugin
This commit is contained in:
Jeff Williams 2013-03-23 18:09:15 -07:00
commit 23914496ea
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
plugins/markdown.js
View File

@ -9,7 +9,8 @@
var conf = env.conf.markdown;
var defaultTags = [ "classdesc", "description", "params", "properties", "returns" ];
var parse = require('jsdoc/util/markdown').getParser();
var tags;
var tags = [];
var excludeTags = [];
/**
* Process the markdown source in a doclet. The properties that should be
@ -36,15 +37,16 @@ function process(doclet) {
// set up the list of "tags" (properties) to process
if (conf && conf.tags) {
tags = conf.tags.slice();
defaultTags.forEach(function(tag) {
if (tags.indexOf(tag) === -1) {
tags.push(tag);
}
});
} else {
tags = defaultTags;
}
// set up the list of default tags to exclude from processing
if (conf && conf.excludeTags) {
excludeTags = conf.excludeTags.slice();
}
defaultTags.forEach(function(tag) {
if (excludeTags.indexOf(tag) === -1 && tags.indexOf(tag) === -1) {
tags.push(tag);
}
});
exports.handlers = {
/**