Add description to symbols and defines
This commit is contained in:
@@ -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;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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)
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user