Add description to symbols and defines

This commit is contained in:
Tim Schaub
2014-05-04 15:07:15 -07:00
parent f9157a6123
commit 070f81aa7d
2 changed files with 3 additions and 0 deletions
+1
View File
@@ -26,6 +26,7 @@ exports.defineTags = function(dictionary) {
doclet.define = { doclet.define = {
default: match[1] === 'true' default: match[1] === 'true'
}; };
doclet.description = tag.value.description;
} }
} }
} }
+2
View File
@@ -39,12 +39,14 @@ exports.publish = function(data, opts) {
if (doc.define) { if (doc.define) {
defines.push({ defines.push({
name: doc.longname, name: doc.longname,
description: doc.description,
path: path.join(doc.meta.path, doc.meta.filename), path: path.join(doc.meta.path, doc.meta.filename),
default: doc.define.default default: doc.define.default
}); });
} else { } else {
symbols.push({ symbols.push({
name: doc.longname, name: doc.longname,
description: doc.description,
extends: doc.augments, extends: doc.augments,
path: path.join(doc.meta.path, doc.meta.filename) path: path.join(doc.meta.path, doc.meta.filename)
}); });